podman/docs/source
Ed Santiago ad7c54e13a 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>
2022-07-14 06:35:51 -06:00
..
_static Show API doc for several versions 2022-02-09 18:17:52 +01:00
markdown man page checker: enforce stricter options format 2022-07-14 06:35:51 -06:00
Commands.rst Add "podman kube play" cmd 2022-07-13 15:27:03 +01:00
Introduction.rst
Reference.rst Add 4.1 branch to API documentation 2022-05-06 15:05:03 +02:00
Search.rst
Tutorials.rst Fix spelling "setup" -> "set up" and similar 2022-06-22 18:39:21 +02:00
conf.py [CI:DOCS] Remove "(1)" from web tab text 2022-03-06 21:40:39 +01:00
includes.rst [CI:DOCS] Fix GitHub URL to Podman logo 2021-07-21 11:22:01 -04:00
index.rst
volume.rst volumes: Add volume import to allow importing contents on tar into volume 2021-08-26 14:14:14 +05:30