From 14d567deae518878d529a437ce882393e00cc3c9 Mon Sep 17 00:00:00 2001 From: Valentin Rothberg Date: Tue, 28 Aug 2018 11:50:33 +0200 Subject: 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 Closes: #1362 Approved by: rhatdan --- docs/podman-create.1.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs/podman-create.1.md') 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. -- cgit v1.2.3-54-g00ecf