summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorQi Wang <qiwan@redhat.com>2019-11-04 15:07:24 -0500
committerQi Wang <qiwan@redhat.com>2019-11-26 13:19:31 -0500
commitd9400cced2afad61eafa18da661891a96db1eafc (patch)
tree6672d5b506ac9355eabdca1804dc62060ac91867 /docs
parentf5ef3d59bcc7e7beae8716ab10153e1eafd634c1 (diff)
downloadpodman-d9400cced2afad61eafa18da661891a96db1eafc.tar.gz
podman-d9400cced2afad61eafa18da661891a96db1eafc.tar.bz2
podman-d9400cced2afad61eafa18da661891a96db1eafc.zip
Remove containers when pruning a stopped pod.
This path allows pod prune & pod rm to remove stopped containers in the pod before deleting the pod. PrunePods and RemovePod should be able to remove containers without force removal of stopped pods. Signed-off-by: Qi Wang <qiwan@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/source/markdown/podman-pod-prune.1.md11
-rw-r--r--docs/source/markdown/podman-pod-rm.1.md4
-rw-r--r--docs/source/markdown/podman-pod.1.md4
-rw-r--r--docs/source/pod.rst4
4 files changed, 14 insertions, 9 deletions
diff --git a/docs/source/markdown/podman-pod-prune.1.md b/docs/source/markdown/podman-pod-prune.1.md
index f79961b2f..478f563c3 100644
--- a/docs/source/markdown/podman-pod-prune.1.md
+++ b/docs/source/markdown/podman-pod-prune.1.md
@@ -1,16 +1,21 @@
% podman-pod-prune(1)
## NAME
-podman-pod-prune - Remove all stopped pods
+podman-pod-prune - Remove all stopped pods and their containers
## SYNOPSIS
**podman pod prune**
## DESCRIPTION
-**podman pod prune** removes all stopped pods from local storage.
+**podman pod prune** removes all stopped pods and their containers from local storage.
+
+## OPTIONS
+
+**--force** **-f**
+Force removal of all running pods and their containers. The default is false.
## EXAMPLES
-Remove all stopped pods from local storage
+Remove all stopped pods and their containers from local storage
```
$ sudo podman pod prune
22b8813332948064b6566370088c5e0230eeaf15a58b1c5646859fd9fc364fe7
diff --git a/docs/source/markdown/podman-pod-rm.1.md b/docs/source/markdown/podman-pod-rm.1.md
index aee582dc6..14da2071f 100644
--- a/docs/source/markdown/podman-pod-rm.1.md
+++ b/docs/source/markdown/podman-pod-rm.1.md
@@ -1,13 +1,13 @@
% podman-pod-rm(1)
## NAME
-podman\-pod\-rm - Remove one or more pods
+podman\-pod\-rm - Remove one or more stopped pods and containers
## SYNOPSIS
**podman pod rm** [*options*] *pod*
## DESCRIPTION
-**podman pod rm** will remove one or more pods from the host. The pod name or ID can be used. The \-f option stops all containers and then removes them before removing the pod. Without the \-f option, a pod cannot be removed if it has associated containers.
+**podman pod rm** will remove one or more stopped pods and their containers from the host. The pod name or ID can be used. The \-f option stops all containers and then removes them before removing the pod.
## OPTIONS
diff --git a/docs/source/markdown/podman-pod.1.md b/docs/source/markdown/podman-pod.1.md
index b3d002a06..e5a8207e9 100644
--- a/docs/source/markdown/podman-pod.1.md
+++ b/docs/source/markdown/podman-pod.1.md
@@ -18,10 +18,10 @@ podman pod is a set of subcommands that manage pods, or groups of containers.
| inspect | [podman-pod-inspect(1)](podman-pod-inspect.1.md) | Displays information describing a pod. |
| kill | [podman-pod-kill(1)](podman-pod-kill.1.md) | Kill the main process of each container in one or more pods. |
| pause | [podman-pod-pause(1)](podman-pod-pause.1.md) | Pause one or more pods. |
-| prune | [podman-pod-prune(1)](podman-pod-prune.1.md) | Remove all stopped pods. |
+| prune | [podman-pod-prune(1)](podman-pod-prune.1.md) | Remove all stopped pods and their containers. |
| ps | [podman-pod-ps(1)](podman-pod-ps.1.md) | Prints out information about pods. |
| restart | [podman-pod-restart(1)](podman-pod-restart.1.md) | Restart one or more pods. |
-| rm | [podman-pod-rm(1)](podman-pod-rm.1.md) | Remove one or more pods. |
+| rm | [podman-pod-rm(1)](podman-pod-rm.1.md) | Remove one or more stopped pods and containers. |
| start | [podman-pod-start(1)](podman-pod-start.1.md) | Start one or more pods. |
| stats | [podman-pod-stats(1)](podman-pod-stats.1.md) | Display a live stream of resource usage stats for containers in one or more pods. |
| stop | [podman-pod-stop(1)](podman-pod-stop.1.md) | Stop one or more pods. |
diff --git a/docs/source/pod.rst b/docs/source/pod.rst
index 391686ce5..2df377762 100644
--- a/docs/source/pod.rst
+++ b/docs/source/pod.rst
@@ -11,13 +11,13 @@ Pod
:doc:`pause <markdown/podman-pause.1>` Pause one or more pods
-:doc:`prune <markdown/podman-pod-prune.1>` Remove all stopped pods
+:doc:`prune <markdown/podman-pod-prune.1>` Remove all stopped pods and their containers
:doc:`ps <markdown/podman-pod-ps.1>` List pods
:doc:`restart <markdown/podman-pod-restart.1>` Restart one or more pods
-:doc:`rm <markdown/podman-pod-rm.1>` Remove one or more pods
+:doc:`rm <markdown/podman-pod-rm.1>` Remove one or more stopped pods and containers
:doc:`start <markdown/podman-pod-start.1>` Start one or more pods