summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-machine-info.1.md
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2022-07-12 10:55:23 -0600
committerEd Santiago <santiago@redhat.com>2022-07-14 06:35:51 -0600
commitad7c54e13a17eed8efb7b1367a17859d6f7e3032 (patch)
tree9655135a3810ef5bbb684460cc5eb6a2c13143a4 /docs/source/markdown/podman-machine-info.1.md
parentd4dc067117931678f0a568998ff34443a12da7e3 (diff)
downloadpodman-ad7c54e13a17eed8efb7b1367a17859d6f7e3032.tar.gz
podman-ad7c54e13a17eed8efb7b1367a17859d6f7e3032.tar.bz2
podman-ad7c54e13a17eed8efb7b1367a17859d6f7e3032.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>
Diffstat (limited to 'docs/source/markdown/podman-machine-info.1.md')
-rw-r--r--docs/source/markdown/podman-machine-info.1.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/source/markdown/podman-machine-info.1.md b/docs/source/markdown/podman-machine-info.1.md
index 33c207d32..926d3d8b3 100644
--- a/docs/source/markdown/podman-machine-info.1.md
+++ b/docs/source/markdown/podman-machine-info.1.md
@@ -13,7 +13,7 @@ Rootless only, as all `podman machine` commands can be only be used with rootles
## OPTIONS
-#### **--format**=*format*, **-f**
+#### **--format**, **-f**=*format*
Change output format to "json" or a Go template.