Update the man page for 'docker commit' to make explicit the fact that
'commit' does not save data in volumes.
Addresses comments in #7583
Signed-off-by: Lars Kellogg-Stedman <lars@redhat.com>
| ... | ... |
@@ -25,6 +25,9 @@ image. This allows you debug a container by running an interactive shell, or to |
| 25 | 25 |
export a working dataset to another server. Generally, it is better to use |
| 26 | 26 |
Dockerfiles to manage your images in a documented and maintainable way. |
| 27 | 27 |
|
| 28 |
+The commit operation will not include any data contained in |
|
| 29 |
+volumes mounted inside the container. |
|
| 30 |
+ |
|
| 28 | 31 |
By default, the container being committed and its processes will be paused |
| 29 | 32 |
while the image is committed. This reduces the likelihood of encountering data |
| 30 | 33 |
corruption during the process of creating the commit. If this behavior is |
| ... | ... |
@@ -14,7 +14,14 @@ docker-commit - Create a new image from a container's changes |
| 14 | 14 |
CONTAINER [REPOSITORY[:TAG]] |
| 15 | 15 |
|
| 16 | 16 |
# DESCRIPTION |
| 17 |
-Using an existing container's name or ID you can create a new image. |
|
| 17 |
+Create a new image from an existing container specified by name or |
|
| 18 |
+container ID. The new image will contain the contents of the |
|
| 19 |
+container filesystem, *excluding* any data volumes. |
|
| 20 |
+ |
|
| 21 |
+While the `docker commit` command is a convenient way of extending an |
|
| 22 |
+existing image, you should prefer the use of a Dockerfile and `docker |
|
| 23 |
+build` for generating images that you intend to share with other |
|
| 24 |
+people. |
|
| 18 | 25 |
|
| 19 | 26 |
# OPTIONS |
| 20 | 27 |
**-a**, **--author**="" |