opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-06-24 03:08:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #9870 from edsantiago/manpage_doubledash_helper

Browse Source 
[CI:DOCS] manpage xref: helpful diagnostic for unescaped dash-dash
This commit is contained in:
OpenShift Merge Robot
2021-03-29 19:53:36 +00:00
committed by GitHub
parent aa96cb6739 cc0bcea4ea
commit 2e9a46c729
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
hack/xref-helpmsgs-manpages
View File

@ -331,6 +331,15 @@ sub podman_man {
@most_recent_flags = (); @most_recent_flags = ();
# As of PR #8292, all options are <h4> and anchored # As of PR #8292, all options are <h4> and anchored
if ($line =~ s/^\#{4}\s+//) { 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. # If option has long and short form, long must come first.
# This is a while-loop because there may be multiple long # This is a while-loop because there may be multiple long
# option names, e.g. --net/--network # option names, e.g. --net/--network