tyler.durden
/
compose
mirror of https://github.com/docker/compose.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
compose/docs/reference
History
Sebastiaan van Stijn 9db79856be
update usage strings for consistency 
This updates the format of various usage strings to be more consistent
with other parts of the CLI.

- Use `[OPTIONS]` to indicate where command-specific options should be added
- Use `[SERVICE...]` to indicate zero-or-more services
- Remove some usage strings for specific options (e.g. `-e NAME=VAL`), as that
  option is part of the already mentioned `[OPTIONS]` and we don't provide usage
  for each possible option that can be passed.
- Remove `[--]`, which (I think) was needed for the Python implementation, but is
  a general feature to stop processing flag-options.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 		2022-08-02 13:32:29 +02:00
..
compose.md cmd: consistent handling no-args commands (#9660) 2022-07-29 09:30:11 -04:00
compose_build.md fix typo in ssh option description 2022-03-31 10:14:13 -04:00
compose_convert.md update cli-doc-tool and update the doc with this new version 2022-07-26 14:58:08 +02:00
compose_cp.md update usage of the index flag of the cp command 2022-05-10 10:50:40 +02:00
compose_create.md add pull & build config to project before create 2022-07-27 11:25:53 +02:00
compose_down.md docs: also generate "usage" in MarkDown files 2022-03-09 14:40:35 +01:00
compose_events.md docs: also generate "usage" in MarkDown files 2022-03-09 14:40:35 +01:00
compose_exec.md docs: also generate "usage" in MarkDown files 2022-03-09 14:40:35 +01:00
compose_images.md docs: also generate "usage" in MarkDown files 2022-03-09 14:40:35 +01:00
compose_kill.md docs: also generate "usage" in MarkDown files 2022-03-09 14:40:35 +01:00
compose_logs.md docs: also generate "usage" in MarkDown files 2022-03-09 14:40:35 +01:00
compose_ls.md docs: also generate "usage" in MarkDown files 2022-03-09 14:40:35 +01:00
compose_pause.md docs: also generate "usage" in MarkDown files 2022-03-09 14:40:35 +01:00
compose_port.md docs: also generate "usage" in MarkDown files 2022-03-09 14:40:35 +01:00
compose_ps.md ps: un-deprecate --filter, and enhance docs 2022-03-10 20:39:19 +01:00
compose_pull.md Fix typo in compose pull documentation 2022-07-04 21:45:53 +02:00
compose_push.md docs: also generate "usage" in MarkDown files 2022-03-09 14:40:35 +01:00
compose_restart.md cmd: consistent handling no-args commands (#9660) 2022-07-29 09:30:11 -04:00
compose_rm.md docs: also generate "usage" in MarkDown files 2022-03-09 14:40:35 +01:00
compose_run.md Fix search/replace typo in --no-TTY documentation 2022-04-04 19:06:03 +02:00
compose_start.md docs: also generate "usage" in MarkDown files 2022-03-09 14:40:35 +01:00
compose_stop.md docs: also generate "usage" in MarkDown files 2022-03-09 14:40:35 +01:00
compose_top.md docs: also generate "usage" in MarkDown files 2022-03-09 14:40:35 +01:00
compose_unpause.md docs: also generate "usage" in MarkDown files 2022-03-09 14:40:35 +01:00
compose_up.md add pull & build config to project before create 2022-07-27 11:25:53 +02:00
compose_version.md docs: also generate "usage" in MarkDown files 2022-03-09 14:40:35 +01:00
docker_compose.yaml update cli-doc-tool and update the doc with this new version 2022-07-26 14:58:08 +02:00
docker_compose_build.yaml update usage strings for consistency 2022-08-02 13:32:29 +02:00
docker_compose_convert.yaml update usage strings for consistency 2022-08-02 13:32:29 +02:00
docker_compose_cp.yaml update cli-doc-tool and update the doc with this new version 2022-07-26 14:58:08 +02:00
docker_compose_create.yaml update usage strings for consistency 2022-08-02 13:32:29 +02:00
docker_compose_down.yaml update usage strings for consistency 2022-08-02 13:32:29 +02:00
docker_compose_events.yaml update usage strings for consistency 2022-08-02 13:32:29 +02:00
docker_compose_exec.yaml update usage strings for consistency 2022-08-02 13:32:29 +02:00
docker_compose_images.yaml update usage strings for consistency 2022-08-02 13:32:29 +02:00
docker_compose_kill.yaml update usage strings for consistency 2022-08-02 13:32:29 +02:00
docker_compose_logs.yaml update usage strings for consistency 2022-08-02 13:32:29 +02:00
docker_compose_ls.yaml update usage strings for consistency 2022-08-02 13:32:29 +02:00
docker_compose_pause.yaml update cli-doc-tool and update the doc with this new version 2022-07-26 14:58:08 +02:00
docker_compose_port.yaml update usage strings for consistency 2022-08-02 13:32:29 +02:00
docker_compose_ps.yaml update usage strings for consistency 2022-08-02 13:32:29 +02:00
docker_compose_pull.yaml update usage strings for consistency 2022-08-02 13:32:29 +02:00
docker_compose_push.yaml update usage strings for consistency 2022-08-02 13:32:29 +02:00
docker_compose_restart.yaml update usage strings for consistency 2022-08-02 13:32:29 +02:00
docker_compose_rm.yaml update usage strings for consistency 2022-08-02 13:32:29 +02:00
docker_compose_run.yaml update usage strings for consistency 2022-08-02 13:32:29 +02:00
docker_compose_start.yaml reference documentation 2021-03-17 09:11:23 +01:00
docker_compose_stop.yaml update usage strings for consistency 2022-08-02 13:32:29 +02:00
docker_compose_top.yaml update cli-doc-tool and update the doc with this new version 2022-07-26 14:58:08 +02:00
docker_compose_unpause.yaml docs: fix "source" path for YAML generator, and regenerate 2022-03-09 14:40:35 +01:00
docker_compose_up.yaml update usage strings for consistency 2022-08-02 13:32:29 +02:00
docker_compose_version.yaml update usage strings for consistency 2022-08-02 13:32:29 +02:00