summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-images.1.md
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2022-07-12 10:55:23 -0600
committerMatthew Heon <matthew.heon@pm.me>2022-07-26 13:22:28 -0400
commit52850ce7049277df028fc8839ab99a15be08ead1 (patch)
treee63c505a055b1c92d0995e9ad70488f246d6c9a2 /docs/source/markdown/podman-images.1.md
parenta5827e13cd6168741badd29e95a81b3c992bf301 (diff)
downloadpodman-52850ce7049277df028fc8839ab99a15be08ead1.tar.gz
podman-52850ce7049277df028fc8839ab99a15be08ead1.tar.bz2
podman-52850ce7049277df028fc8839ab99a15be08ead1.zip
man page checker: enforce stricter options format
Followup to #14906, in which a nonexistent option was found in a man page. The xref script was designed to catch that, but I was too lax in my parsing: the option was documented using wrong syntax, and the script didn't catch it. Solution: do not allow *any* unrecognized cruft in the option description lines. And fix all improperly-written entries to conform to the rule: **--option**=*value(s)* Two asterisks around option, which must have two dashes. One asterisk around value(s). This is going to cause headaches for some people adding new options, but I don't think I can fix that: there are many factors that make an unparseable line. Adding 'hint' code would make the script even more complex than it is. I have to assume that our contributors are smart enough to look at surrounding context and figure out the right way to specify options. Signed-off-by: Ed Santiago <santiago@redhat.com> <MH: Fixed cherry-pick conflicts> Signed-off-by: Matthew Heon <matthew.heon@pm.me>
Diffstat (limited to 'docs/source/markdown/podman-images.1.md')
-rw-r--r--docs/source/markdown/podman-images.1.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/source/markdown/podman-images.1.md b/docs/source/markdown/podman-images.1.md
index e28df840d..923b22f1b 100644
--- a/docs/source/markdown/podman-images.1.md
+++ b/docs/source/markdown/podman-images.1.md
@@ -23,7 +23,7 @@ Show all images (by default filter out the intermediate image layers). The defau
Show image digests
-#### **--filter**=*filter*, **-f**
+#### **--filter**, **-f**=*filter*
Provide filter values.
@@ -100,9 +100,9 @@ Omit the table headings from the listing of images.
Lists only the image IDs.
-#### **--sort**=*sort*=*created*
+#### **--sort**=*sort*
-Sort by created, id, repository, size or tag (default: created)
+Sort by *created*, *id*, *repository*, *size* or *tag* (default: **created**)
## EXAMPLE