From e939dd3776b1e510ceda196eec9102aac41bb95f Mon Sep 17 00:00:00 2001 From: Yong Tang Date: Wed, 24 Aug 2016 23:21:38 +0000 Subject: [PATCH] Update build docs to include path for scripts. This fix updates the build docs to include the path of `build/` for shell scripts. The reason is that while trying to follow the `build/README.md`, it is not obvious that all the scripts, e.g., `run.sh make`, `shell.sh`, etc. needs to be executed from the root directory (vs. executed from the `build/` directory). In other words, the executation should be: ``` build/run.sh make build/make-clean.sh ... ``` This fix adds `build/` so that it is easy for user to follow the steps. --- build/README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/build/README.md b/build/README.md index 951ea14559f..0a6bdfd9f0e 100644 --- a/build/README.md +++ b/build/README.md @@ -21,18 +21,18 @@ There is also early support for building Docker "run" containers ## Key scripts -The following scripts are found in the `build/` directory: +The following scripts are found in the `build/` directory. Note that all scripts must be run from the Kubernetes root directory. -* `run.sh`: Run a command in a build docker container. Common invocations: - * `run.sh make`: Build just linux binaries in the container. Pass options and packages as necessary. - * `run.sh make cross`: Build all binaries for all platforms - * `run.sh make test`: Run all unit tests - * `run.sh make test-integration`: Run integration test - * `run.sh make test-cmd`: Run CLI tests -* `copy-output.sh`: This will copy the contents of `_output/dockerized/bin` from any remote Docker container to the local `_output/dockerized/bin`. Right now this is only necessary on Mac OS X with `boot2docker` when your git repo isn't under `/Users`. -* `make-clean.sh`: Clean out the contents of `_output/dockerized` and remove any local built container images. -* `shell.sh`: Drop into a `bash` shell in a build container with a snapshot of the current repo code. -* `release.sh`: Build everything, test it, and (optionally) upload the results to a GCS bucket. +* `build/run.sh`: Run a command in a build docker container. Common invocations: + * `build/run.sh make`: Build just linux binaries in the container. Pass options and packages as necessary. + * `build/run.sh make cross`: Build all binaries for all platforms + * `build/run.sh make test`: Run all unit tests + * `build/run.sh make test-integration`: Run integration test + * `build/run.sh make test-cmd`: Run CLI tests +* `build/copy-output.sh`: This will copy the contents of `_output/dockerized/bin` from any remote Docker container to the local `_output/dockerized/bin`. Right now this is only necessary on Mac OS X with `boot2docker` when your git repo isn't under `/Users`. +* `build/make-clean.sh`: Clean out the contents of `_output/dockerized` and remove any local built container images. +* `build/shell.sh`: Drop into a `bash` shell in a build container with a snapshot of the current repo code. +* `build/release.sh`: Build everything, test it, and (optionally) upload the results to a GCS bucket. ## Releasing