Guillaume Lours
3d0dd57fbd
docs: ps --format json outputs JSON Lines, not a JSON array
...
ci / validate (lint) (push) Waiting to run
ci / validate (validate-docs) (push) Waiting to run
ci / validate (validate-go-mod) (push) Waiting to run
ci / validate (validate-headers) (push) Waiting to run
ci / binary (push) Waiting to run
ci / binary-finalize (push) Blocked by required conditions
ci / bin-image-test (push) Waiting to run
ci / test (push) Waiting to run
ci / e2e (plugin, oldstable) (push) Waiting to run
ci / e2e (standalone, oldstable) (push) Waiting to run
ci / e2e (plugin, stable) (push) Waiting to run
ci / e2e (standalone, stable) (push) Waiting to run
ci / coverage (push) Blocked by required conditions
ci / release (push) Blocked by required conditions
merge / bin-image-prepare (push) Waiting to run
merge / bin-image (push) Blocked by required conditions
merge / module-image (push) Waiting to run
merge / desktop-edge-test (push) Blocked by required conditions
Scorecards supply-chain security / Scorecards analysis (push) Waiting to run
docs-upstream / docs-yaml (push) Has been cancelled
docs-upstream / validate (push) Has been cancelled
Output was aligned with `docker ps --format json` in v2.21.0 (#10918 )
but the docs were never updated.
Fixes #13850
Signed-off-by: Guillaume Lours <glours@users.noreply.github.com>
2026-06-23 16:18:12 +02:00
Piotr Dąbrowski
e330f5905b
docs: unify no trailing dots in docstrings and help ( #11301 )
2024-02-14 14:02:37 -05:00
Nicolas De Loof
caa0cbbc4b
Introduce ps --orphans so user can include/exclude services not declared by project
...
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2023-11-23 13:43:49 +01:00
aevesdocker
4cd61957ed
fix build
...
Signed-off-by: aevesdocker <allie.sadler@docker.com>
2023-10-31 10:50:42 +00:00
Nicolas De Loof
44d21280e7
truncate command by default, introduce --no-trunc flag to get the full command
...
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2023-09-23 06:34:26 +02:00
Nicolas De Loof
1054792b47
align docker compose ps with docker CLI to support --format
...
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2023-08-25 16:36:45 +02: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 <milas.bowman@docker.com>
2023-07-10 12:23:48 +02:00
Guillaume Lours
312f0d1d61
Update dry-run documentation
...
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
2023-05-15 09:39:46 +02:00
Nicolas De Loof
4721c01702
fix docs to reflect docker compose ps being aligned with docker ps
...
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2023-01-24 11:11:20 +01:00
Nicolas De Loof
8c39b5b7fd
align --format flag and UX with docker cli
...
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2022-12-14 22:53:43 +01:00
Umar Faruq Chowdhury
06e71371ff
docs: fix grammatical issues ( #9997 )
...
Signed-off-by: Umar Chowdhury <umarfchy@gmail.com>
Co-authored-by: Milas Bowman <milasb@gmail.com>
2022-11-29 10:52:22 -05: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 <github@gone.nl>
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 <guillaume.lours@docker.com>
2022-07-26 14:58:08 +02:00
Sebastiaan van Stijn
2d32d7450c
ps: un-deprecate --filter, and enhance docs
...
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>
2022-03-10 20:39:19 +01:00
Sebastiaan van Stijn
b9b3a3d91f
docs: update cli-docs-tool to v0.4.0
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-03-09 14:40:35 +01:00
Sebastiaan van Stijn
35b790dcdf
docs: fix "source" path for YAML generator, and regenerate
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-03-09 14:40:35 +01:00
Sebastiaan van Stijn
3678deed14
[v2] use "docker/cli-docs-tool" to generate docs
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-09-13 21:54:26 +02:00
Sebastiaan van Stijn
fdc362bf55
[v2] docs: markdown and link fixes
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-09-13 21:54:26 +02:00
Sebastiaan van Stijn
1c01e9d00f
[v2] docs: regenerate yaml docs
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-09-13 21:54:26 +02:00
Nicolas De Loof
abbba74b27
update reference docs
...
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2021-06-08 09:39:49 +02:00
Nicolas De Loof
3271801681
reference documentation
...
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2021-03-17 09:11:23 +01:00
Nicolas De Loof
59d4382f3c
generate reference documentation
...
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2021-03-09 13:44:13 +01:00
