Commit Graph
16 Commits
Author SHA1 Message Date
Guillaume Lours f729794270 docs(hooks): document pre_start hook container retention and cleanup
- compose_down.md: note that retained pre_start hook containers (those
  kept after a hook failure for post-mortem) are automatically removed
  by compose down, with the label filter to list them beforehand.
- compose_up.md: note the retention behavior on pre_start hook failure,
  how to inspect the retained container, and that it is cleaned up on
  the next compose up or compose down.

Signed-off-by: Guillaume Lours <[email protected]>
2026-08-20 18:57:02 +02:00
Piotr Dąbrowski e330f5905b docs: unify no trailing dots in docstrings and help (#11301) 2024-02-14 14:02:37 -05:00
aevesdocker 4cd61957ed fix build
Signed-off-by: aevesdocker <[email protected]>
2023-10-31 10:50:42 +00:00
Milas Bowman baea5a48f5 deps: bump docker/cli-docs-tool to v0.6.0
Required re-running `make docs` to pick up changes.

Signed-off-by: Milas Bowman <[email protected]>
2023-07-10 12:23:48 +02:00
robbert-ef 68bd0eb523 cli: fix timeout behavior on up / restart / stop (#10672)
Do not set a hardcoded default timeout of 10 seconds when restarting / stopping but use the container `StopTimeout` (defaults to 10 seconds).

Also fixed custom timeout not used when invoking `up`.

Signed-off-by: Robbert Segeren <[email protected]>
2023-06-12 09:18:25 -04:00
Guillaume Lours 15cad92b61 fix display of volumes flag in down help command
Signed-off-by: Guillaume Lours <[email protected]>
2023-05-24 22:11:58 +02:00
Nicolas De Loof 93bd27a0cc introduce ability to select service to be stopped by compose down
Signed-off-by: Nicolas De Loof <[email protected]>
2023-05-24 17:32:32 +02:00
Guillaume LoursandAllie Sadler 312f0d1d61 Update dry-run documentation
Co-authored-by: Allie Sadler <[email protected]>
Signed-off-by: Guillaume Lours <[email protected]>
2023-05-15 09:39:46 +02:00
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 <[email protected]>
2022-08-02 13:32:29 +02:00
Guillaume Lours 0e6adb2884 update cli-doc-tool and update the doc with this new version
Signed-off-by: Guillaume Lours <[email protected]>
2022-07-26 14:58:08 +02:00
Sebastiaan van Stijn b9b3a3d91f docs: update cli-docs-tool to v0.4.0
Signed-off-by: Sebastiaan van Stijn <[email protected]>
2022-03-09 14:40:35 +01:00
Sebastiaan van Stijn 0b896c69ce [v2] docs: fix stray backtick, and add compose_version yaml
Signed-off-by: Sebastiaan van Stijn <[email protected]>
2021-09-14 07:49:29 +02:00
Sebastiaan van Stijn 3678deed14 [v2] use "docker/cli-docs-tool" to generate docs
Signed-off-by: Sebastiaan van Stijn <[email protected]>
2021-09-13 21:54:26 +02:00
Sebastiaan van Stijn 1c01e9d00f [v2] docs: regenerate yaml docs
Signed-off-by: Sebastiaan van Stijn <[email protected]>
2021-09-13 21:54:26 +02:00
Nicolas De Loof 3271801681 reference documentation
Signed-off-by: Nicolas De Loof <[email protected]>
2021-03-17 09:11:23 +01:00
Nicolas De Loof 59d4382f3c generate reference documentation
Signed-off-by: Nicolas De Loof <[email protected]>
2021-03-09 13:44:13 +01:00