summaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2021-08-26 13:01:44 -0400
committerGitHub <noreply@github.com>2021-08-26 13:01:44 -0400
commit70caa63e7cfc4a2b70722058be9f315b4a76defe (patch)
treea989cf6685727eb5f72dddf1a7876964ac2b3771 /docs/source
parent18da5b0bf6d83e31a3db534068af367816349cf0 (diff)
parent1e6d1e5c6babd87aa2f18e66a30df7da50aeb395 (diff)
downloadpodman-70caa63e7cfc4a2b70722058be9f315b4a76defe.tar.gz
podman-70caa63e7cfc4a2b70722058be9f315b4a76defe.tar.bz2
podman-70caa63e7cfc4a2b70722058be9f315b4a76defe.zip
Merge pull request #11318 from jmguzik/volume-ls-prune-docs
[CI:DOCS] Add filter params description to volume list/prune docs
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/markdown/podman-volume-ls.1.md16
-rw-r--r--docs/source/markdown/podman-volume-prune.1.md6
2 files changed, 13 insertions, 9 deletions
diff --git a/docs/source/markdown/podman-volume-ls.1.md b/docs/source/markdown/podman-volume-ls.1.md
index b562aff61..6c80ec152 100644
--- a/docs/source/markdown/podman-volume-ls.1.md
+++ b/docs/source/markdown/podman-volume-ls.1.md
@@ -18,13 +18,15 @@ flag. Use the **--quiet** flag to print only the volume names.
Volumes can be filtered by the following attributes:
-- dangling
-- driver
-- label
-- name
-- opt
-- scope
-- until
+| **Filter** | **Description** |
+| ---------- | ------------------------------------------------------------------------------------- |
+| dangling | [Dangling] Matches all volumes not referenced by any containers |
+| driver | [Driver] Matches volumes based on their driver |
+| label | [Key] or [Key=Value] Label assigned to a volume |
+| name | [Name] Volume name (accepts regex) |
+| opt | Matches a storage driver options |
+| scope | Filters volume by scope |
+| until | Only remove volumes created before given timestamp |
#### **--format**=*format*
diff --git a/docs/source/markdown/podman-volume-prune.1.md b/docs/source/markdown/podman-volume-prune.1.md
index b9599c200..cfdfc1a44 100644
--- a/docs/source/markdown/podman-volume-prune.1.md
+++ b/docs/source/markdown/podman-volume-prune.1.md
@@ -23,8 +23,10 @@ Do not prompt for confirmation.
Filter volumes to be pruned. Volumes can be filtered by the following attributes:
-- label
-- until
+| **Filter** | **Description** |
+| ---------- | ------------------------------------------------------------------------------------- |
+| label | [Key] or [Key=Value] Label assigned to a volume |
+| until | Only remove volumes created before given timestamp |
#### **--help**