summaryrefslogtreecommitdiff
path: root/hack/xref-helpmsgs-manpages
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2021-03-29 12:56:22 -0600
committerEd Santiago <santiago@redhat.com>2021-03-29 13:00:11 -0600
commitcc0bcea4eafd355e49a2ea3f2470a647bdc9206c (patch)
tree139a0d72bbaab7d3ef472f0a9e21e14353497c94 /hack/xref-helpmsgs-manpages
parent3d6dcdc7a4f9270df79de77f76ad8176fbda82a0 (diff)
downloadpodman-cc0bcea4eafd355e49a2ea3f2470a647bdc9206c.tar.gz
podman-cc0bcea4eafd355e49a2ea3f2470a647bdc9206c.tar.bz2
podman-cc0bcea4eafd355e49a2ea3f2470a647bdc9206c.zip
manpage xref: helpful diagnostic for unescaped dash-dash
PR #9856 works around a buggy markdown processor that cleverly converts double dashes to em-dash. The unfortunate result is that the man page source files are unmaintainable, because every '--foo' has to be specified as '\-\-foo'. This is impossible for humans to remember, so let's add a helpful diagnostic message when we detect new options added without the escapes. Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'hack/xref-helpmsgs-manpages')
-rwxr-xr-xhack/xref-helpmsgs-manpages9
1 files changed, 9 insertions, 0 deletions
diff --git a/hack/xref-helpmsgs-manpages b/hack/xref-helpmsgs-manpages
index 42dd3634f..25e972fbc 100755
--- a/hack/xref-helpmsgs-manpages
+++ b/hack/xref-helpmsgs-manpages
@@ -331,6 +331,15 @@ sub podman_man {
@most_recent_flags = ();
# As of PR #8292, all options are <h4> and anchored
if ($line =~ s/^\#{4}\s+//) {
+ # 2021-03: PR #9856: some (bleep) markdown processor converts
+ # double dashes to a single em-dash. We need to escape every
+ # instance with backslashes. This is anti-intuitive, and
+ # developers will naturally write --foo; try to catch that
+ # and warn with a helpful message.
+ if ($line =~ /--([a-z]+)/) {
+ warn "$ME: $subpath:$.: You probably need to backslash-escape '--$1' as '\\-\\-$1'\n";
+ }
+
# If option has long and short form, long must come first.
# This is a while-loop because there may be multiple long
# option names, e.g. --net/--network