ソースを参照

Update docs for new `compose kill` `--remove-orphans` option

Signed-off-by: Laura Brehm <[email protected]>
Laura Brehm 3 年 前
コミット
a226fe9daf
2 ファイル変更11 行追加0 行削除
  1. 1 0
      docs/reference/compose_kill.md
  2. 10 0
      docs/reference/docker_compose_kill.yaml

+ 1 - 0
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. |
 
 

+ 10 - 0
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