From f5a2e578ebdcc38468fc777018099a6cc732c0f0 Mon Sep 17 00:00:00 2001
From: Paul Holzinger <paul.holzinger@web.de>
Date: Thu, 12 Nov 2020 20:32:30 +0100
Subject: Maintain consistent order of short and long flag names in docs
Make the order of short and long flag names in the documentation
consistent. Also adjust the man page validaten script to only allow
the `**--long**, **-s**` syntax.
Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
---
hack/xref-helpmsgs-manpages | 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)
(limited to 'hack')
diff --git a/hack/xref-helpmsgs-manpages b/hack/xref-helpmsgs-manpages
index 082cc63f2..c5447c5d6 100755
--- a/hack/xref-helpmsgs-manpages
+++ b/hack/xref-helpmsgs-manpages
@@ -331,8 +331,15 @@ sub podman_man {
@most_recent_flags = ();
# As of PR #8292, all options are <h4> and anchored
if ($line =~ s/^\#{4}\s+//) {
- # Handle any variation of '**--foo**, **-f**'
- while ($line =~ s/^\*\*((--[a-z0-9-]+)|(-.))\*\*(,\s+)?//g) {
+ # 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;
+ }
+ # Short form
+ if ($line =~ s/^\*\*(-[a-zA-Z0-9])\*\*(=\*[a-zA-Z0-9-]+\*)?//g) {
$man{$1} = 1;
# Keep track of them, in case we see 'Not implemented' below
--
cgit v1.2.3-54-g00ecf