Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: document a server only build (no tests) #255

Merged
merged 1 commit into from
Nov 30, 2016
Merged

docs: document a server only build (no tests) #255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions ci/do_ci.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,23 @@ if [[ "$1" == "docs" ]]; then
make docs
exit 0
elif [[ "$1" == "coverage" ]]; then
echo "coverage build..."
echo "coverage build with tests..."
EXTRA_CMAKE_FLAGS="-DENVOY_CODE_COVERAGE:BOOL=ON"
TEST_TARGET="envoy.check-coverage"
elif [[ "$1" == "asan" ]]; then
echo "asan build..."
echo "asan build with tests..."
EXTRA_CMAKE_FLAGS="-DENVOY_SANITIZE:BOOL=ON -DENVOY_DEBUG:BOOL=OFF"
TEST_TARGET="envoy.check"
elif [[ "$1" == "debug" ]]; then
echo "debug build..."
echo "debug build with tests..."
EXTRA_CMAKE_FLAGS="-DENVOY_DEBUG:BOOL=ON"
TEST_TARGET="envoy.check"
elif [[ "$1" == "server_only" ]]; then
echo "normal build server only..."
EXTRA_CMAKE_FLAGS="-DENVOY_DEBUG:BOOL=OFF"
TEST_TARGET="envoy"
else
echo "normal build..."
echo "normal build with tests..."
EXTRA_CMAKE_FLAGS="-DENVOY_DEBUG:BOOL=OFF"
TEST_TARGET="envoy.check"
fi
Expand Down
6 changes: 4 additions & 2 deletions docs/install/building.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@ Building

The Envoy build system uses cmake. In order to ease initial building and for a quick start, we
provide an Ubuntu 14 based docker container that has everything needed inside of it to build
and *statically link* envoy. The following command will build and run all of the tests.
and *statically link* envoy. The following command will build the server.

.. code-block:: console

docker run -t -i -v <SOURCE_DIR>:/source lyft/envoy-build:latest /bin/bash -c "cd /source && ci/do_ci.sh normal"
docker run -t -i -v <SOURCE_DIR>:/source lyft/envoy-build:latest /bin/bash -c "cd /source && ci/do_ci.sh server_only"

See :repo:`ci/do_ci.sh` for other possible targets (to run tests, etc.).

In order to build manually, cmake is used like so:

Expand Down