[Rpm-maint] [rpm-software-management/rpm] Bunch of man page formatting fixes + minor cleanups (PR #3607)
Michal Domonkos
notifications at github.com
Fri Feb 28 16:26:06 UTC 2025
@dmnks commented on this pull request.
Didn't go through each and every replacement but looks alright. Can't end up worse than it is, really :smile:
Some comments inline.
>
## INSTALLING, UPGRADING, AND REMOVING PACKAGES
-*rpm* {*-i|--install*} [*install-options*] *PACKAGE_FILE ...*
+*rpm* {*-i*|*--install*} [install-options] _PACKAGE_FILE_ [...]
I'm thinking that the square brackets around the ellipsis are redundant, since *that* is what the ellipsis itself means ("preceding argument can be repeated 0 or more times") :sweat_smile:
That also seems in line with `man-pages(7)`:
> Brackets ([]) surround optional arguments, vertical bars (|) separate choices, and ellipses (...) can be repeated.
>
The following erase-options options may also be used:
*--allmatches*
- Remove all versions of the package which match *PACKAGE_NAME*.
- Normally an error is issued if *PACKAGE_NAME* matches multiple
+ Remove all versions of the package which match PACKAGE_NAME.
+ Normally an error is issued if PACKAGE_NAME matches multiple
These two should've been `_PACKAGE_NAME_` I think :smile:
>
# DESCRIPTION
*rpm2cpio* converts the .rpm file specified as a single argument to a
-cpio archive on standard out. If a '-' argument is given as *FILE*, an rpm
+cpio archive on standard out. If a '-' argument is given as FILE, an rpm
`_FILE_`?
--
Reply to this email directly or view it on GitHub:
https://github.com/rpm-software-management/rpm/pull/3607#pullrequestreview-2651198449
You are receiving this because you are subscribed to this thread.
Message ID: <rpm-software-management/rpm/pull/3607/review/2651198449 at github.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rpm.org/pipermail/rpm-maint/attachments/20250228/7cc5ab3e/attachment.htm>
More information about the Rpm-maint
mailing list