Merge pull request containers#11318 from jmguzik/volume-ls-prune-docs

[CI:DOCS] Add filter params description to volume list/prune docs
Luap99 · Aug 26, 2021 · 70caa63 · 70caa63
2 parents 18da5b0 + 1e6d1e5
commit 70caa63
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 9 deletions.
diff --git 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
@@ -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**