Skip to content

Commit

Permalink
misc link fixes (envoyproxy#1654)
Browse files Browse the repository at this point in the history
  • Loading branch information
mattklein123 authored and htuch committed Sep 15, 2017
1 parent 855fa4f commit 12f9e3b
Show file tree
Hide file tree
Showing 22 changed files with 40 additions and 40 deletions.
4 changes: 2 additions & 2 deletions DEPRECATED.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# DEPRECATED

As of release 1.3.0, Envoy will follow a
[Breaking Change Policy](https://github.com/lyft/envoy/blob/master//CONTRIBUTING.md#breaking-change-policy).
[Breaking Change Policy](https://github.com/envoyproxy/envoy/blob/master//CONTRIBUTING.md#breaking-change-policy).

The following features have been DEPRECATED and will be removed in the specified release cycle.

Expand All @@ -14,7 +14,7 @@ The following features have been DEPRECATED and will be removed in the specified
* The following log macros have been deprecated: `log_trace`, `log_debug`, `conn_log`,
`conn_log_info`, `conn_log_debug`, `conn_log_trace`, `stream_log`, `stream_log_info`,
`stream_log_debug`, `stream_log_trace`. For replacements, please see
[logger.h](https://github.com/lyft/envoy/blob/master/source/common/common/logger.h).
[logger.h](https://github.com/envoyproxy/envoy/blob/master/source/common/common/logger.h).
* The connectionId() and ssl() callbacks of StreamFilterCallbacks have been deprecated and
replaced with a more general connection() callback, which, when not returning a nullptr, can be
used to get the connection id and SSL connection from the returned Connection object pointer.
Expand Down
14 changes: 7 additions & 7 deletions DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,20 @@

Envoy is built using the Bazel build system. Travis CI builds, tests, and runs coverage against all pull requests and the master branch.

To get started building Envoy locally, see the [Bazel quick start](https://github.com/lyft/envoy/blob/master/bazel/README.md#quick-start-bazel-build-for-developers). To run tests, there are Bazel [targets](https://github.com/lyft/envoy/blob/master/bazel/README.md#testing-envoy-with-bazel) for Google Test. To generate a coverage report, use the tooling for [gcovr](https://github.com/lyft/envoy/blob/master/bazel/README.md#coverage-builds).
To get started building Envoy locally, see the [Bazel quick start](https://github.com/envoyproxy/envoy/blob/master/bazel/README.md#quick-start-bazel-build-for-developers). To run tests, there are Bazel [targets](https://github.com/envoyproxy/envoy/blob/master/bazel/README.md#testing-envoy-with-bazel) for Google Test. To generate a coverage report, use the tooling for [gcovr](https://github.com/envoyproxy/envoy/blob/master/bazel/README.md#coverage-builds).

Below is a list of additional documentation to aid the development process:

- [General build and installation documentation](https://lyft.github.io/envoy/docs/install/install.html)
- [General build and installation documentation](https://envoyproxy.github.io/envoy/install/install.html)

- [Building and testing Envoy with Bazel](https://github.com/lyft/envoy/blob/master/bazel/README.md)
- [Building and testing Envoy with Bazel](https://github.com/envoyproxy/envoy/blob/master/bazel/README.md)

- [Managing external dependencies with Bazel](https://github.com/lyft/envoy/blob/master/bazel/EXTERNAL_DEPS.md)
- [Managing external dependencies with Bazel](https://github.com/envoyproxy/envoy/blob/master/bazel/EXTERNAL_DEPS.md)

- [Guide to Envoy Bazel rules (managing `BUILD` files)](https://github.com/lyft/envoy/blob/master/bazel/DEVELOPER.md)
- [Guide to Envoy Bazel rules (managing `BUILD` files)](https://github.com/envoyproxy/envoy/blob/master/bazel/DEVELOPER.md)

- [Using Docker for building and testing](https://github.com/lyft/envoy/tree/master/ci)
- [Using Docker for building and testing](https://github.com/envoyproxy/envoy/tree/master/ci)

- [Guide to contributing to Envoy](https://github.com/lyft/envoy/blob/master/CONTRIBUTING.md)
- [Guide to contributing to Envoy](https://github.com/envoyproxy/envoy/blob/master/CONTRIBUTING.md)

- [Envoy filter example project (how to consume and extend Envoy as a submodule)](https://github.com/lyft/envoy-filter-example)
18 changes: 9 additions & 9 deletions bazel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,23 @@
## Production environments

To build Envoy with Bazel in a production environment, where the [Envoy
dependencies](https://lyft.github.io/envoy/docs/install/requirements.html) are typically
dependencies](https://envoyproxy.github.io/envoy/install/requirements.html) are typically
independently sourced, the following steps should be followed:

1. [Install Bazel](https://bazel.build/versions/master/docs/install.html) in your environment.
2. Configure, build and/or install the [Envoy dependencies](https://lyft.github.io/envoy/docs/install/requirements.html).
2. Configure, build and/or install the [Envoy dependencies](https://envoyproxy.github.io/envoy/install/requirements.html).
3. Configure a Bazel [WORKSPACE](https://bazel.build/versions/master/docs/be/workspace.html)
to point Bazel at the Envoy dependencies. An example is provided in the CI Docker image
[WORKSPACE](https://github.com/lyft/envoy/blob/master/ci/WORKSPACE) and corresponding
[BUILD](https://github.com/lyft/envoy/blob/master/ci/prebuilt/BUILD) files.
[WORKSPACE](https://github.com/envoyproxy/envoy/blob/master/ci/WORKSPACE) and corresponding
[BUILD](https://github.com/envoyproxy/envoy/blob/master/ci/prebuilt/BUILD) files.
4. `bazel build --package_path %workspace%:<path to Envoy source tree> //source/exe:envoy-static`
from the directory containing your WORKSPACE.

## Quick start Bazel build for developers

As a developer convenience, a [WORKSPACE](https://github.com/lyft/envoy/blob/master/WORKSPACE) and
As a developer convenience, a [WORKSPACE](https://github.com/envoyproxy/envoy/blob/master/WORKSPACE) and
[rules for building a recent
version](https://github.com/lyft/envoy/blob/master/bazel/repositories.bzl) of the various Envoy
version](https://github.com/envoyproxy/envoy/blob/master/bazel/repositories.bzl) of the various Envoy
dependencies are provided. These are provided as is, they are only suitable for development and
testing purposes. The specific versions of the Envoy dependencies used in this build may not be
up-to-date with the latest security patches.
Expand Down Expand Up @@ -60,7 +60,7 @@ Bazel can also be built with the Docker image used for CI, by installing Docker
./ci/run_envoy_docker.sh './ci/do_ci.sh bazel.dev'
```

See also the [documentation](https://github.com/lyft/envoy/tree/master/ci) for developer use of the
See also the [documentation](https://github.com/envoyproxy/envoy/tree/master/ci) for developer use of the
CI Docker image.

## Using a compiler toolchain in a non-standard location
Expand Down Expand Up @@ -93,7 +93,7 @@ bazel test //test/...
An individual test target can be run with a more specific Bazel
[label](https://bazel.build/versions/master/docs/build-ref.html#Labels), e.g. to build and run only
the units tests in
[test/common/http/async_client_impl_test.cc](https://github.com/lyft/envoy/blob/master/test/common/http/async_client_impl_test.cc):
[test/common/http/async_client_impl_test.cc](https://github.com/envoyproxy/envoy/blob/master/test/common/http/async_client_impl_test.cc):

```
bazel test //test/common/http:async_client_impl_test
Expand Down Expand Up @@ -264,7 +264,7 @@ https://github.com/bazelbuild/bazel/issues/2805.
To generate coverage results, make sure you have
[`gcovr`](https://github.com/gcovr/gcovr) 3.3 in your `PATH` (or set `GCOVR` to
point at it) and are using a GCC toolchain (clang does not work currently, see
https://github.com/lyft/envoy/issues/1000). Then run:
https://github.com/envoyproxy/envoy/issues/1000). Then run:

```
test/run_envoy_bazel_coverage.sh
Expand Down
2 changes: 1 addition & 1 deletion bazel/repositories.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ def _repository_impl(ctxt):
if result.return_code != 0:
print("\033[31;1m\033[48;5;226m External dependency build failed, check above log " +
"for errors and ensure all prerequisites at " +
"https://github.com/lyft/envoy/blob/master/bazel/README.md#quick-start-bazel-build-for-developers are met.")
"https://github.com/envoyproxy/envoy/blob/master/bazel/README.md#quick-start-bazel-build-for-developers are met.")
# This error message doesn't appear to the user :( https://github.com/bazelbuild/bazel/issues/3683
fail("External dep build failed")

Expand Down
2 changes: 1 addition & 1 deletion ci/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Two flavors of Envoy Docker images, based on Ubuntu and Alpine Linux, are built.

## Ubuntu envoy image
The Ubuntu based Envoy Docker image at [`lyft/envoy-build:<hash>`](https://hub.docker.com/r/lyft/envoy-build/) is used for Travis CI checks,
where `<hash>` is specified in [`envoy_build_sha.sh`](https://github.com/lyft/envoy/blob/master/ci/envoy_build_sha.sh). Developers
where `<hash>` is specified in [`envoy_build_sha.sh`](https://github.com/envoyproxy/envoy/blob/master/ci/envoy_build_sha.sh). Developers
may work with `lyft/envoy-build:latest` to provide a self-contained environment for building Envoy binaries and
running tests that reflects the latest built Ubuntu Envoy image. Moreover, the Docker image
at [`lyft/envoy:<hash>`](https://hub.docker.com/r/lyft/envoy/) is an image that has an Envoy binary at `/usr/local/bin/envoy`. The `<hash>`
Expand Down
2 changes: 1 addition & 1 deletion ci/build_container/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ image. The image is pushed to [dockerhub](https://hub.docker.com/r/lyft/envoy-bu

After the PR that changes `ci/build_container` has been merged, and the new image gets pushed,
a second PR is needed to update `ci/envoy_build_sha.sh`. In order to pull the new tagged version of
the build image, change ENVOY_BUILD_SHA [here](https://github.com/lyft/envoy/blob/master/ci/envoy_build_sha.sh). Any PRs that depend on this image change will have to merge master after the change to `ci/envoy_build_sha.sh` has been merged to master.
the build image, change ENVOY_BUILD_SHA [here](https://github.com/envoyproxy/envoy/blob/master/ci/envoy_build_sha.sh). Any PRs that depend on this image change will have to merge master after the change to `ci/envoy_build_sha.sh` has been merged to master.
2 changes: 1 addition & 1 deletion ci/build_container/build_recipes/lightstep.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ wget -O lightstep-tracer-cpp-"$VERSION".tar.gz https://github.com/lightstep/ligh
tar xf lightstep-tracer-cpp-"$VERSION".tar.gz
cd lightstep-tracer-cpp-"$VERSION"

# see https://github.com/lyft/envoy/issues/1387 for progress
# see https://github.com/envoyproxy/envoy/issues/1387 for progress
cat > ../lightstep-missing-header.diff << EOF
--- ./src/c++11/lightstep/options.h.bak 2017-08-04 09:30:19.527076744 -0400
+++ ./src/c++11/lightstep/options.h 2017-08-04 09:30:33.742106924 -0400
Expand Down
2 changes: 1 addition & 1 deletion ci/build_setup.sh
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ mkdir -p "${ENVOY_COVERAGE_DIR}"
# This is where we build for bazel.release* and bazel.dev.
export ENVOY_CI_DIR="${ENVOY_SRCDIR}"/ci

# Hack due to https://github.com/lyft/envoy/issues/838 and the need to have
# Hack due to https://github.com/envoyproxy/envoy/issues/838 and the need to have
# tools and bazel.rc available for build linkstamping.
mkdir -p "${ENVOY_FILTER_EXAMPLE_SRCDIR}"/tools
mkdir -p "${ENVOY_CI_DIR}"/tools
Expand Down
2 changes: 1 addition & 1 deletion ci/ci_steps.sh
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ else
mkdir -p build_release
cp -f "$ENVOY_BUILD_DIR"/envoy/source/exe/envoy ./build_release
# This script builds lyft/envoy and lyft/envoy-alpine images and pushes that image on merge to master.
# It also makes sure that the docker examples (https://lyft.github.io/envoy/docs/install/sandboxes/sandboxes.html)
# It also makes sure that the docker examples (https://envoyproxy.github.io/envoy/install/sandboxes/sandboxes.html)
# can be built and run.
./ci/docker_push.sh
fi
Expand Down
6 changes: 3 additions & 3 deletions ci/verify_examples.sh
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ tar -xf go1.7.1.linux-amd64.tar.gz
sudo mv go /usr/local
export PATH=$PATH:/usr/local/go/bin
export GOPATH=$HOME/go
mkdir -p $GOPATH/src/github.com/lyft/envoy/examples/
cp -r grpc-bridge $GOPATH/src/github.com/lyft/envoy/examples/
mkdir -p $GOPATH/src/github.com/envoyproxy/envoy/examples/
cp -r grpc-bridge $GOPATH/src/github.com/envoyproxy/envoy/examples/
# build example
cd $GOPATH/src/github.com/lyft/envoy/examples/grpc-bridge
cd $GOPATH/src/github.com/envoyproxy/envoy/examples/grpc-bridge
./script/bootstrap
./script/build
# verify example works
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The output can be found in `generated/docs`.

The Envoy website, and docs are automatically built, and pushed on every commit
to master. This process is handled by Travis CI with the
[`publish.sh`](https://github.com/lyft/envoy/blob/master/docs/publish.sh) script.
[`publish.sh`](https://github.com/envoyproxy/envoy/blob/master/docs/publish.sh) script.

In order to have this automatic process there is an encrypted ssh key at the root
of the envoy repo (`.publishdocskey.enc`). This key was encrypted with Travis CLI
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
# ones.
extensions = ['sphinxcontrib.httpdomain', 'sphinx.ext.extlinks']

extlinks = {'repo': ('https://github.com/lyft/envoy/blob/master/%s', '')}
extlinks = {'repo': ('https://github.com/envoyproxy/envoy/blob/master/%s', '')}

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down
2 changes: 1 addition & 1 deletion examples/front-proxy/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
To learn about this sandbox and for instructions on how to run it please head over
to the [envoy docs](https://lyft.github.io/envoy/docs/install/sandboxes/front_proxy.html)
to the [envoy docs](https://envoyproxy.github.io/envoy/install/sandboxes/front_proxy.html)
2 changes: 1 addition & 1 deletion examples/grpc-bridge/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
To learn about this sandbox and for instructions on how to run it please head over
to the [envoy docs](https://lyft.github.io/envoy/docs/install/sandboxes/grpc_bridge.html)
to the [envoy docs](https://envoyproxy.github.io/envoy/install/sandboxes/grpc_bridge.html)
2 changes: 1 addition & 1 deletion examples/grpc-bridge/service/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (

"sync"

"github.com/lyft/envoy/examples/grpc-bridge/service/gen"
"github.com/envoyproxy/envoy/examples/grpc-bridge/service/gen"
"golang.org/x/net/context"
"google.golang.org/grpc"
)
Expand Down
2 changes: 1 addition & 1 deletion examples/jaeger-tracing/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
To learn about this sandbox and for instructions on how to run it please head over
to the [envoy docs](https://lyft.github.io/envoy/docs/install/sandboxes/jaeger_tracing.html)
to the [envoy docs](https://envoyproxy.github.io/envoy/install/sandboxes/jaeger_tracing.html)
2 changes: 1 addition & 1 deletion examples/zipkin-tracing/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
To learn about this sandbox and for instructions on how to run it please head over
to the [envoy docs](https://lyft.github.io/envoy/docs/install/sandboxes/zipkin_tracing.html)
to the [envoy docs](https://envoyproxy.github.io/envoy/install/sandboxes/zipkin_tracing.html)
2 changes: 1 addition & 1 deletion include/envoy/grpc/rpc_channel.h
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ class RpcChannelCallbacks {
* object. An RpcChannel should be passed to the constructor of an RPC stub
* generated via protoc using the "option cc_generic_services = true;" option.
* It can be used for multiple service calls, but not concurrently.
* DEPRECATED: See https://github.com/lyft/envoy/issues/1102
* DEPRECATED: See https://github.com/envoyproxy/envoy/issues/1102
*/
class RpcChannel : public Protobuf::RpcChannel {
public:
Expand Down
2 changes: 1 addition & 1 deletion source/common/grpc/rpc_channel_impl.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ namespace Grpc {
* needed.
* 4) Inflight RPCs can be safely cancelled using cancel().
* 5) See GrpcRequestImplTest for an example.
* DEPRECATED: See https://github.com/lyft/envoy/issues/1102
* DEPRECATED: See https://github.com/envoyproxy/envoy/issues/1102
*/
class RpcChannelImpl : public RpcChannel, public Http::AsyncClient::Callbacks {
public:
Expand Down
2 changes: 1 addition & 1 deletion source/common/http/utility.cc
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ void Utility::sendLocalReply(
if (!body_text.empty() && !is_reset) {
Buffer::OwnedImpl buffer(body_text);
// TODO(htuch): We shouldn't encodeData() if the stream is reset in the encodeHeaders() above,
// see https://github.com/lyft/envoy/issues/1283.
// see https://github.com/envoyproxy/envoy/issues/1283.
encode_data(buffer, true);
}
}
Expand Down
4 changes: 2 additions & 2 deletions source/common/local_info/local_info_impl.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ class LocalInfoImpl : public LocalInfo {
}
}

// TODO(PiotrSikora): Revert https://github.com/lyft/envoy/pull/1500 once protobuf string types
// converge.
// TODO(PiotrSikora): Revert https://github.com/envoyproxy/envoy/pull/1500 once protobuf string
// types converge.

Network::Address::InstanceConstSharedPtr address() const override { return address_; }
const std::string zoneName() const override { return node_.locality().zone(); }
Expand Down
2 changes: 1 addition & 1 deletion tools/bazel.rc
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ build:clang-tsan --linkopt -fsanitize=thread
build:clang-tsan --define tcmalloc=disabled

# Clang 5.0 MSAN - broken today since we need to rebuild lib[std]c++ and external deps with MSAN
# support (see https://github.com/lyft/envoy/issues/443).
# support (see https://github.com/envoyproxy/envoy/issues/443).
build:clang-msan --copt -fsanitize=memory
build:clang-msan --linkopt -fsanitize=memory
build:clang-msan --define tcmalloc=disabled
Expand Down

0 comments on commit 12f9e3b

Please sign in to comment.