Browse Source

Add docs for auto-removal on daemon

Docs for #20848: move "--rm" to daemon side.

Add description for introduced API changes.

Signed-off-by: Zhang Wei <zhangwei555@huawei.com>
Zhang Wei 9 years ago
parent
commit
7df815d2af

+ 1 - 1
docs/reference/api/docker_remote_api.md

@@ -116,7 +116,7 @@ This section lists each version from latest to oldest.  Each listing includes a
 
 
 [Docker Remote API v1.25](docker_remote_api_v1.25.md) documentation
 [Docker Remote API v1.25](docker_remote_api_v1.25.md) documentation
 
 
-* `POST /containers/create` now takes `AutoRemove` in HostConfig, auto-removal will be done on daemon side.
+* `POST /containers/create` now takes `AutoRemove` in HostConfig, to enable auto-removal of the container on daemon side when the container's process exits.
 
 
 ### v1.24 API changes
 ### v1.24 API changes
 
 

+ 2 - 0
docs/reference/api/docker_remote_api_v1.25.md

@@ -459,6 +459,8 @@ Create a container
             The default is not to restart. (optional)
             The default is not to restart. (optional)
             An ever increasing delay (double the previous delay, starting at 100mS)
             An ever increasing delay (double the previous delay, starting at 100mS)
             is added before each restart to prevent flooding the server.
             is added before each restart to prevent flooding the server.
+    -   **AutoRemove** - Boolean value, set to `true` to automatically remove the container on daemon side
+            when the container's process exits.
     -   **UsernsMode**  - Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
     -   **UsernsMode**  - Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
            supported values are: `host`.
            supported values are: `host`.
     -   **NetworkMode** - Sets the networking mode for the container. Supported
     -   **NetworkMode** - Sets the networking mode for the container. Supported