summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMatthew Heon <mheon@redhat.com>2018-11-28 12:48:58 -0500
committerMatthew Heon <mheon@redhat.com>2018-12-06 09:10:45 -0500
commit28bead8be8eb541cf0c78e6ee3a3963adc8d1d3a (patch)
tree4797664994d7a0639f40ab0526bbc0466d66a330 /docs
parenta0c9be20617a871c6cb61f27516565af36338d7a (diff)
downloadpodman-28bead8be8eb541cf0c78e6ee3a3963adc8d1d3a.tar.gz
podman-28bead8be8eb541cf0c78e6ee3a3963adc8d1d3a.tar.bz2
podman-28bead8be8eb541cf0c78e6ee3a3963adc8d1d3a.zip
Add --sync flag to podman ps
The previous commit added support for --sync to podman rm to ensure state inconsistencies would not prevent containers from being removed. Add the flag to podman ps as well, so that all containers can be forcibly synced and all state inconsistencies resolved. Signed-off-by: Matthew Heon <mheon@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/podman-ps.1.md7
-rw-r--r--docs/podman-rm.1.md2
2 files changed, 8 insertions, 1 deletions
diff --git a/docs/podman-ps.1.md b/docs/podman-ps.1.md
index 7333a1095..8b86703d8 100644
--- a/docs/podman-ps.1.md
+++ b/docs/podman-ps.1.md
@@ -103,6 +103,13 @@ Valid filters are listed below:
Print usage statement
+**--sync**
+
+Force a sync of container state with the OCI runtime.
+In some cases, a container's state in the runtime can become out of sync with Podman's state.
+This will update Podman's state based on what the OCI runtime reports.
+Forcibly syncing is much slower, but can resolve inconsistent state issues.
+
## EXAMPLES
```
diff --git a/docs/podman-rm.1.md b/docs/podman-rm.1.md
index 7f22113ea..57274c523 100644
--- a/docs/podman-rm.1.md
+++ b/docs/podman-rm.1.md
@@ -26,7 +26,7 @@ to run containers such as CRI-O, the last started container could be from either
**--sync**
-Force a sync of container state with the OCI runtime before attempting to remove.
+Force a sync of container state with the OCI runtime before attempting to remove the container.
In some cases, a container's state in the runtime can become out of sync with Podman's state,
which can cause Podman to refuse to remove containers because it believes they are still running.
A sync will resolve this issue.