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>
Enforce args rejection for commands without args:
* ls
* version
Additionally, docs for `restart` are fixed.
Signed-off-by: piroux <pierre.roux01@gmail.com>
There was an invalid character between the two backticks at the end of the last snippet, causing the styling to break on the online documentation.
Signed-off-by: Emmanuel Nuiro <emmanuel@nuiro.me>
Commit abbba74b27 looks to have
accidentally replaced `pseudo-tty` with `pseudo-noTty` in several
places. In other places, it looks like it replaced `pseudo-tty` with
`pseudo-TTY`, so I used the uppercased version in these places as well.
For example, running version 2.3.3, I get this output:
```
% docker-compose run --help
...
Options:
...
-T, --no-TTY Disable pseudo-noTty allocation. By default docker compose run allocates a TTY
...
```
Signed-off-by: Eric Freese <ericdfreese@gmail.com>
Compose currently only supports a single filter options on --filter,
for which reason the --status flag was added, which is more convenient
to use.
However, the `--filter` flag is common among various docker commands, and
it's possible that additional filters get added at some point (which may
be less "commonly" used, and not warrant a dedicated flag).
This PR removes the "deprecated" mention from the flag, to keep consistency
with other commands, but adds documentation to explain how they relate to
eachother.
Also added a short example for the `--format` flag.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Trailing whitespace in Markdown can force line-breaks, which doesn't seem to
be the intent on these;
find . -type f -print0 | xargs -0 perl -pi -e 's/ +$//'
The trailing whitespace also can cause the YAML to go wonky (although the
cli-docs-tool now takes that into account), and caused the "examples" section
to be missed in the `docker compose pull` page (something we should fix in
the tool).
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Nick Sieger
Laura Brehm
Khoa Le
Sebastiaan van Stijn
Pierre Roux
Guillaume Lours
Emmanuel Nuiro
Guillaume Lours
Daniel Lublin
Eric Freese
Matthias Schoettle
Zixuan James Li
Dan Bámíkíyá
Manu
Nicolas De Loof
Guillaume Tardif
Guillaume Tardif
Ulysses Souza