aboutsummaryrefslogtreecommitdiff
path: root/hack
diff options
context:
space:
mode:
authorPaul Holzinger <paul.holzinger@web.de>2021-03-29 13:52:59 +0200
committerMatthew Heon <mheon@redhat.com>2021-03-29 13:53:50 -0400
commitac4bdd265308f549c4db775c1674077a6c669b30 (patch)
treea95f579c2d855ea2e4797fe04ee55aa20ec03372 /hack
parent96ffce2198785c9d5717e3104f0afd8a0c38b6af (diff)
downloadpodman-ac4bdd265308f549c4db775c1674077a6c669b30.tar.gz
podman-ac4bdd265308f549c4db775c1674077a6c669b30.tar.bz2
podman-ac4bdd265308f549c4db775c1674077a6c669b30.zip
Fix long option format on docs.podman.io
Escape the two dashes, otherwise they are combined into one long dash. I tested that this change is safe and still renders correctly on github and with the man pages. This commit also contains a small change to make it build locally. Assuming you have the dependencies installed you can do: ``` cd docs make html ``` Preview the html files in docs/build/html with `python -m http.server 8000 --directory build/html`. Fixes containers/podman.io#373 Signed-off-by: Paul Holzinger <paul.holzinger@web.de> <MH: Fixed cherry-pick conflicts> Signed-off-by: Matthew Heon <mheon@redhat.com>
Diffstat (limited to 'hack')
-rwxr-xr-xhack/xref-helpmsgs-manpages10
1 files changed, 6 insertions, 4 deletions
diff --git a/hack/xref-helpmsgs-manpages b/hack/xref-helpmsgs-manpages
index 08e56c77e..42dd3634f 100755
--- a/hack/xref-helpmsgs-manpages
+++ b/hack/xref-helpmsgs-manpages
@@ -320,7 +320,7 @@ sub podman_man {
}
}
- # Options should always be of the form '**-f**' or '**--flag**',
+ # Options should always be of the form '**-f**' or '**\-\-flag**',
# possibly separated by comma-space.
elsif ($section eq 'flags') {
# e.g. 'podman run --ip6', documented in man page, but nonexistent
@@ -334,9 +334,11 @@ sub podman_man {
# 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
- while ($line =~ s/^\*\*(--[a-z0-9-]+)\*\*(=\*[a-zA-Z0-9-]+\*)?(,\s+)?//g) {
- $man{$1} = 1;
- push @most_recent_flags, $1;
+ while ($line =~ s/^\*\*\\-\\-([a-z0-9-]+)\*\*(=\*[a-zA-Z0-9-]+\*)?(,\s+)?//g) {
+ # add -- to the flag name
+ my $flag = "--".$1;
+ $man{$flag} = 1;
+ push @most_recent_flags, $flag;
}
# Short form
if ($line =~ s/^\*\*(-[a-zA-Z0-9])\*\*(=\*[a-zA-Z0-9-]+\*)?//g) {