From a226fe9daf6d86a1835d595f67080c66f4d0dbc8 Mon Sep 17 00:00:00 2001 From: Laura Brehm Date: Fri, 19 Aug 2022 04:29:51 +0200 Subject: [PATCH] Update docs for new `compose kill` `--remove-orphans` option Signed-off-by: Laura Brehm --- docs/reference/compose_kill.md | 1 + docs/reference/docker_compose_kill.yaml | 10 ++++++++++ 2 files changed, 11 insertions(+) diff --git a/docs/reference/compose_kill.md b/docs/reference/compose_kill.md index d0512faae..35c613507 100644 --- a/docs/reference/compose_kill.md +++ b/docs/reference/compose_kill.md @@ -7,6 +7,7 @@ Force stop service containers. | Name | Type | Default | Description | | --- | --- | --- | --- | +| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | | `-s`, `--signal` | `string` | `SIGKILL` | SIGNAL to send to the container. | diff --git a/docs/reference/docker_compose_kill.yaml b/docs/reference/docker_compose_kill.yaml index c082c80c0..b286a9876 100644 --- a/docs/reference/docker_compose_kill.yaml +++ b/docs/reference/docker_compose_kill.yaml @@ -10,6 +10,16 @@ usage: docker compose kill [OPTIONS] [SERVICE...] pname: docker compose plink: docker_compose.yaml options: + - option: remove-orphans + value_type: bool + default_value: "false" + description: Remove containers for services not defined in the Compose file. + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: signal shorthand: s value_type: string