diff options
| author | Valentin Rothberg <vrothberg@suse.com> | 2018-08-28 11:50:33 +0200 |
|---|---|---|
| committer | Atomic Bot <atomic-devel@projectatomic.io> | 2018-08-28 16:28:43 +0000 |
| commit | 14d567deae518878d529a437ce882393e00cc3c9 (patch) | |
| tree | 148426db553c39e78ad7eebefb67a994000eedd3 /docs | |
| parent | 1a90b2fd363bec5f9b57c1cd829ceb5890270f8c (diff) | |
| download | podman-14d567deae518878d529a437ce882393e00cc3c9.tar.gz podman-14d567deae518878d529a437ce882393e00cc3c9.tar.bz2 podman-14d567deae518878d529a437ce882393e00cc3c9.zip | |
document `--rm` semantics
The `--rm` flag will only cause a container to be removed when it has
been created and started successfully. Otherwise, it will not be
removed to allow the container to be inspected and to analyze the root
cause of the failure. Document those semantics more clearly in the
manpages to avoid confusion for users.
Fixes: #1359
Signed-off-by: Valentin Rothberg <vrothberg@suse.com>
Closes: #1362
Approved by: rhatdan
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/podman-create.1.md | 4 | ||||
| -rw-r--r-- | docs/podman-run.1.md | 4 |
2 files changed, 8 insertions, 0 deletions
diff --git a/docs/podman-create.1.md b/docs/podman-create.1.md index b396fb6b5..1866d68a4 100644 --- a/docs/podman-create.1.md +++ b/docs/podman-create.1.md @@ -477,6 +477,10 @@ its root filesystem mounted as read only prohibiting any writes. Automatically remove the container when it exits. The default is *false*. +Note that the container will not be removed when it could not be created or +started successfully. This allows the user to inspect the container after +failure. The `--rm` flag is incompatible with the `-d` flag. + **--rootfs** If specified, the first argument refers to an exploded container on the file system. diff --git a/docs/podman-run.1.md b/docs/podman-run.1.md index 482ca1b32..8df8b08fe 100644 --- a/docs/podman-run.1.md +++ b/docs/podman-run.1.md @@ -498,6 +498,10 @@ its root filesystem mounted as read only prohibiting any writes. Automatically remove the container when it exits. The default is *false*. +Note that the container will not be removed when it could not be created or +started successfully. This allows the user to inspect the container after +failure. The `--rm` flag is incompatible with the `-d` flag. + **--rootfs** If specified, the first argument refers to an exploded container on the file system. |