浏览代码

Merge pull request #10604 from aevesdocker/ENGDOCS-1373

update docs to reflect dry run mode is feature complete
Guillaume Lours 2 年之前
父节点
当前提交
419fcdd6c8
共有 2 个文件被更改,包括 2 次插入43 次删除
  1. 1 22
      docs/reference/compose.md
  2. 1 21
      docs/reference/docker_compose.yaml

+ 1 - 22
docs/reference/compose.md

@@ -171,7 +171,6 @@ If flags are explicitly set on the command line, the associated environment vari
 Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` will stop docker compose from detecting orphaned
 containers for the project.
 
-
 ### Use Dry Run mode to test your command
 
 Use `--dry-run` flag to test a command without changing your application stack state.
@@ -195,24 +194,4 @@ $ docker compose --dry-run up --build -d
 From the example above, you can see that the first step is to pull the image defined by `db` service, then build the `backend` service.  
 Next, the containers are created. The `db` service is started, and the `backend` and `proxy` wait until the `db` service is healthy before starting.
 
-Dry Run mode does not currently work with all commands. In particular, you cannot use Dry Run mode with a command that doesn't change the state of a Compose stack
-such as `ps`, `ls`, `logs` for example.  
-
-Here the list of commands supporting `--dry-run` flag:
-* build
-* cp
-* create
-* down
-* exec
-* kill
-* pause
-* pull
-* push
-* remove
-* restart
-* run
-* start
-* stop
-* unpause
-* up
-
+Dry Run mode works with almost all commands. You cannot use Dry Run mode with a command that doesn't change the state of a Compose stack such as `ps`, `ls`, `logs` for example.  

+ 1 - 21
docs/reference/docker_compose.yaml

@@ -118,7 +118,6 @@ long: |-
     Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` will stop docker compose from detecting orphaned
     containers for the project.
 
-
     ### Use Dry Run mode to test your command
 
     Use `--dry-run` flag to test a command without changing your application stack state.
@@ -142,26 +141,7 @@ long: |-
     From the example above, you can see that the first step is to pull the image defined by `db` service, then build the `backend` service.
     Next, the containers are created. The `db` service is started, and the `backend` and `proxy` wait until the `db` service is healthy before starting.
 
-    Dry Run mode does not currently work with all commands. In particular, you cannot use Dry Run mode with a command that doesn't change the state of a Compose stack
-    such as `ps`, `ls`, `logs` for example.
-
-    Here the list of commands supporting `--dry-run` flag:
-    * build
-    * cp
-    * create
-    * down
-    * exec
-    * kill
-    * pause
-    * pull
-    * push
-    * remove
-    * restart
-    * run
-    * start
-    * stop
-    * unpause
-    * up
+    Dry Run mode works with almost all commands. You cannot use Dry Run mode with a command that doesn't change the state of a Compose stack such as `ps`, `ls`, `logs` for example.
 usage: docker compose
 pname: docker
 plink: docker.yaml