diff options
author | Ed Santiago <santiago@redhat.com> | 2022-07-12 10:55:23 -0600 |
---|---|---|
committer | Matthew Heon <matthew.heon@pm.me> | 2022-07-26 13:22:28 -0400 |
commit | 52850ce7049277df028fc8839ab99a15be08ead1 (patch) | |
tree | e63c505a055b1c92d0995e9ad70488f246d6c9a2 /docs/source/markdown/podman-info.1.md | |
parent | a5827e13cd6168741badd29e95a81b3c992bf301 (diff) | |
download | podman-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-info.1.md')
-rw-r--r-- | docs/source/markdown/podman-info.1.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/source/markdown/podman-info.1.md b/docs/source/markdown/podman-info.1.md index 28e4f3291..347d8d27b 100644 --- a/docs/source/markdown/podman-info.1.md +++ b/docs/source/markdown/podman-info.1.md @@ -19,7 +19,7 @@ Displays information pertinent to the host, current storage stats, configured co Show additional information -#### **--format**=*format*, **-f** +#### **--format**, **-f**=*format* Change output format to "json" or a Go template. |