man pages: sort flags, and keep them that way

Command flags (OPTIONS) in man pages have to date been in
haphazard order. Sometimes that order is sensible, e.g.,
most-important options first, but more often they're
just in arbitrary places. This makes life hard for users.

Here, I update the man-page-check Makefile script so it
checks and enforces alphabetical order in OPTIONS sections.
Then -- the hard part -- update all existing man pages to
conform to this requirement.

Signed-off-by: Ed Santiago <santiago@redhat.com>
This commit is contained in:
Ed Santiago
2022-03-23 12:29:08 -06:00
parent 7371306280
commit 9b0c8d23bd
50 changed files with 618 additions and 603 deletions

View File

@ -12,14 +12,6 @@ Lists all the secrets that exist. The output can be formatted to a Go template u
## OPTIONS
#### **--format**=*format*
Format secret output using Go template.
#### **--noheading**
Omit the table headings from the listing of secrets. .
#### **--filter**, **-f**=*filter=value*
Filter output based on conditions given.
@ -32,6 +24,14 @@ Valid filters are listed below:
| name | [Name] Secret name (accepts regex) |
| id | [ID] Full or partial secret ID |
#### **--format**=*format*
Format secret output using Go template.
#### **--noheading**
Omit the table headings from the listing of secrets. .
## EXAMPLES
```