summaryrefslogtreecommitdiff
path: root/hack
diff options
context:
space:
mode:
authorDaniel J Walsh <dwalsh@redhat.com>2020-10-15 15:00:59 -0400
committerDaniel J Walsh <dwalsh@redhat.com>2020-10-21 08:37:57 -0400
commit980b1e87d40eedc175cdc76da668572b91784448 (patch)
treeb79db728f8e6b388021ecce2dc3e2337a92eba11 /hack
parent9d9c58ba64a59fc24d6807f495559ac2ec86b6e8 (diff)
downloadpodman-980b1e87d40eedc175cdc76da668572b91784448.tar.gz
podman-980b1e87d40eedc175cdc76da668572b91784448.tar.bz2
podman-980b1e87d40eedc175cdc76da668572b91784448.zip
Switch use of Flags to Options
Want to have man pages match commands, since we have lots of printed man pages with using Options, we will change the command line to use Options in --help. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
Diffstat (limited to 'hack')
-rwxr-xr-xhack/man-page-checker4
-rwxr-xr-xhack/xref-helpmsgs-manpages6
2 files changed, 5 insertions, 5 deletions
diff --git a/hack/man-page-checker b/hack/man-page-checker
index 45f9edbd1..8ee0aaf6d 100755
--- a/hack/man-page-checker
+++ b/hack/man-page-checker
@@ -92,10 +92,10 @@ function compare_usage() {
# man page lists 'foo [*options*]', help msg shows 'foo [flags]'.
# Make sure if one has it, the other does too.
if expr "$from_man" : "\[\*options\*\]" >/dev/null; then
- if expr "$from_help" : "\[flags\]" >/dev/null; then
+ if expr "$from_help" : "\[options\]" >/dev/null; then
:
else
- echo "WARNING: $cmd: man page shows '[*options*]', help does not show [flags]"
+ echo "WARNING: $cmd: man page shows '[*options*]', help does not show [options]"
rc=1
fi
elif expr "$from_help" : "\[flags\]" >/dev/null; then
diff --git a/hack/xref-helpmsgs-manpages b/hack/xref-helpmsgs-manpages
index 7b617eed7..a7063259f 100755
--- a/hack/xref-helpmsgs-manpages
+++ b/hack/xref-helpmsgs-manpages
@@ -228,14 +228,14 @@ sub podman_help {
# Usage: ...
# Available Commands:
# ....
- # Flags:
+ # Options:
# ....
#
# Start by identifying the section we're in...
if ($line =~ /^Available\s+(Commands):/) {
$section = lc $1;
}
- elsif ($line =~ /^(Flags):/) {
+ elsif ($line =~ /^(Options):/) {
$section = lc $1;
}
@@ -320,7 +320,7 @@ sub podman_man {
}
}
- # Flags 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