[CI:DOCS] Maintain consistent order of short and long flag names in docs

[Luap99]

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 [email protected]

[Luap99]

@edsantiago PTAL and check the regex.

[rhatdan]

LGTM

[edsantiago]

Something is broken, because you missed one in podman-create.1.md (--hostname) and the script isn't complaining. I'm looking into it now.

[edsantiago]

Friendly suggestion:

diff --git a/hack/xref-helpmsgs-manpages b/hack/xref-helpmsgs-manpages
index 557b22446..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**=*bar*, **-f**'
-                while ($line =~ s/^\*\*((--[a-z0-9-]+)|(-[a-zA-Z0-9]))\*\*((=\*[a-zA-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

It's ugly, but it's the best I can do on short notice. You will need to fix --hostname in podman-create.md. And while you're at it, could you look at --net,--network in podman-{build,create,run}.1.md, choose one form or the other, and make those consistent? I don't have a good way to add that consistency check to the xref script.

[Luap99]

podman build doesn't support the --net alias I opend #8322

[rhatdan]

That is a bug, but I am fine with fixing the man pages for now.

[Luap99]

Thanks @edsantiago. It should be working now.

[edsantiago]

LGTM but I'd like an extra set of eyes on the newly-changed portions of podman*-create.1.md

[rhatdan]

/lgtm
/approve

[openshift-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Luap99, rhatdan

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [rhatdan]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment