From c239914df688b73e22ce4054608697dc7fc16d01 Mon Sep 17 00:00:00 2001 From: Victoria Bialas Date: Mon, 5 Jun 2017 17:35:44 -0700 Subject: [PATCH] Compose CLI reference copyedits (#3499) Signed-off-by: Victoria Bialas --- compose/reference/build.md | 2 +- compose/reference/config.md | 2 +- compose/reference/envvars.md | 2 +- compose/reference/overview.md | 6 +++--- compose/reference/restart.md | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/compose/reference/build.md b/compose/reference/build.md index 0ed0501de5..fb53977f88 100644 --- a/compose/reference/build.md +++ b/compose/reference/build.md @@ -17,7 +17,7 @@ Options: ``` Services are built once and then tagged, by default as `project_service`, e.g., -`composetest_db`. If the compose file specify an +`composetest_db`. If the Compose file specifies an [image](/compose/compose-file/index.md#image) name, the image will be tagged with that name, substituting any variables beforehand. See [variable substitution](#variable-substitution) diff --git a/compose/reference/config.md b/compose/reference/config.md index b6ac71d0cb..5292b575f2 100644 --- a/compose/reference/config.md +++ b/compose/reference/config.md @@ -16,4 +16,4 @@ Options: --volumes Print the volume names, one per line. ``` -Validate and view the compose file. +Validate and view the Compose file. diff --git a/compose/reference/envvars.md b/compose/reference/envvars.md index 1ecbe721e2..e222094b54 100644 --- a/compose/reference/envvars.md +++ b/compose/reference/envvars.md @@ -30,7 +30,7 @@ Specify the path to a Compose file. If not provided, Compose looks for a file na `docker-compose.yml` in the current directory and then each parent directory in succession until a file by that name is found. -This variable supports multiple compose files separated by a path separator (on +This variable supports multiple Compose files separated by a path separator (on Linux and macOS the path separator is `:`, on Windows it is `;`). For example: `COMPOSE_FILE=docker-compose.yml:docker-compose.prod.yml`. The path separator can also be customized using `COMPOSE_PATH_SEPARATOR`. diff --git a/compose/reference/overview.md b/compose/reference/overview.md index fab378bf50..d5c80e7e8d 100644 --- a/compose/reference/overview.md +++ b/compose/reference/overview.md @@ -19,7 +19,7 @@ Usage: docker-compose -h|--help Options: - -f, --file FILE Specify an alternate compose file (default: docker-compose.yml) + -f, --file FILE Specify an alternate Compose file (default: docker-compose.yml) -p, --project-name NAME Specify an alternate project name (default: directory name) --verbose Show more output -v, --version Print version and exit @@ -34,12 +34,12 @@ Options: in the client certificate (for example if your docker host is an IP address) --project-directory PATH Specify an alternate working directory - (default: the path of the compose file) + (default: the path of the Compose file) Commands: build Build or rebuild services bundle Generate a Docker bundle from the Compose file - config Validate and view the compose file + config Validate and view the Compose file create Create services down Stop and remove containers, networks, images, and volumes events Receive real time events from containers diff --git a/compose/reference/restart.md b/compose/reference/restart.md index e449ba546d..f11b078535 100644 --- a/compose/reference/restart.md +++ b/compose/reference/restart.md @@ -14,6 +14,6 @@ Options: Restarts all stopped and running services. -If you make changes to your docker-compose.yml configuration these changes will not be reflected after running this command. +If you make changes to your `docker-compose.yml` configuration these changes will not be reflected after running this command. For example, changes to environment variables (which are added after a container is built, but before the container's command is executed) will not be updated after restarting.