@dmnks commented on this pull request.


> @@ -0,0 +1,229 @@
+RPM-COMMON(8)
+
+# NAME
+rpm-common - operations and options common to the main *rpm*(8) executables

s/operations/Operations/

> @@ -0,0 +1,229 @@
+RPM-COMMON(8)
+
+# NAME
+rpm-common - operations and options common to the main *rpm*(8) executables
+
+# SYNOPSIS
+_RPMCMD_ [options] {*-?*|*--help*}

We have **rpmcmd** in the template. Technically, this is a user-supplied 
argument (argument 0) so perhaps it's correct but not sure...

> +RPM-COMMON(8)
+
+# NAME
+rpm-common - operations and options common to the main *rpm*(8) executables
+
+# SYNOPSIS
+_RPMCMD_ [options] {*-?*|*--help*}
+
+_RPMCMD_ [options] *--showrc*
+
+_RPMCMD_ [options] *--version*
+
+# DESCRIPTION
+The following *rpm* executables share common configuration and the
+options and operations documented in this manual:
+- *rpm*(8)

I'm thinking if it makes sense to list these. It's easy to get out of sync, and 
we already link from the relevant commands to this man page.

> +*-?*,
+*--help*
+       Print a longer usage message than normal.
+
+*--version*
+       Print a single line containing the version number of *rpm* being
+       used.
+
+*--showrc*
+       Dump information about *rpm* configuration to standard output.
+
+# ARGUMENTS
+The common operations take no arguments.
+
+# OPTIONS
+*--color* <*never*|*auto*|*always*>

You'll notice this one so just making a bookmark here :smile: 

> +     for the common macro definition needs.
+
+*--quiet*
+       Print as little as possible - normally only error messages will be
+       displayed.
+
+*--rcfile* _FILELIST_
+       Replace the default list of configuration files to be read with
+       _FILELIST_.  See *rpmrc Configuration* for details.
+
+*--root* _DIRECTORY_
+       Use the file system tree rooted at _DIRECTORY_ for all operations.
+       Note that this means the database within _DIRECTORY_ will be used
+       for dependency checks and any scriptlet(s) (e.g. *%post* if
+       installing, or *%prep* if building, a package) will be run after a
+       chroot(2) to _DIRECTORY_.

Missing bold

> +     be displayed. Supply more than once to increase verbosity, eg. *-vv*.
+
+# DEBUG OPTIONS
+*--debug*
+       Print lots of debug information.
+
+*--fsmdebug*
+       Print debuging information of payload handling code.
+
+*--rpmiodebug*
+       Print debug information about file IO.
+
+*--stats*
+       Print runtime statistics of often used functions.
+
+# DEBUG OPTIONS

Duplicate section (except `--deploops`)

> +     root directory.
+
+*--undefine*='_MACRO_'
+       Undefines _MACRO_.
+
+*-v*,
+*--verbose*
+       Print verbose information - normally routine progress messages will
+       be displayed. Supply more than once to increase verbosity, eg. *-vv*.
+
+# DEBUG OPTIONS
+*--debug*
+       Print lots of debug information.
+
+*--fsmdebug*
+       Print debuging information of payload handling code.

debugging

> +*curl*(1) or *wget*(1) for fetching data from the internet.
+
+For some operations, *rpm* can act as an FTP and/or HTTP client so that
+packages can be queried or installed from the internet. Package files for
+install, upgrade, and query operations may be specified as an *ftp* or *http*
+style URL:
+
+_http://HOST[:PORT]/path/to/package.rpm_
+
+_ftp://[USER:PASSWORD]@HOST[:PORT]/path/to/package.rpm_
+
+If both the user and password are omitted, anonymous *ftp* is used.
+
+*rpm* allows the following options to be used with ftp URLs:
+
+*rpm* allows the following options to be used with *http* and *ftp* URLs:

Duplicate line

> +packages can be queried or installed from the internet. Package files for
+install, upgrade, and query operations may be specified as an *ftp* or *http*
+style URL:
+
+_http://HOST[:PORT]/path/to/package.rpm_
+
+_ftp://[USER:PASSWORD]@HOST[:PORT]/path/to/package.rpm_
+
+If both the user and password are omitted, anonymous *ftp* is used.
+
+*rpm* allows the following options to be used with ftp URLs:
+
+*rpm* allows the following options to be used with *http* and *ftp* URLs:
+
+*--httpproxy* _HOST_
+       The host _HOST_ will be used as a proxy server for all *http* and

Maybe just `The _HOST_ will be used` ?

> +     proxy http server instead of the default port. This option may also
+       be specified by configuring the macro *%\_httpport*.
+
+# ENVIRONMENT
+*RPM_CONFIGDIR*
+       Used to override the default *rpm* configuration home,
+       typically _/usr/lib/rpm_.
+
+# EXIT STATUS
+On success, 0 is returned, a non-zero failure code otherwise.
+
+# FILES
+
+## rpmrc Configuration
+
+Each file in the colon separated rpmrc path is read sequentially by

"rpmrc" is not obivous in this context. Is that the `--rcfile` option?

> +     installing, or *%prep* if building, a package) will be run after a
+       chroot(2) to _DIRECTORY_.
+
+       Note that rpm assumes the environment inside the root is set up by
+       the caller, such as any mounts needed for the operation inside the
+       root directory.
+
+*--undefine*='_MACRO_'
+       Undefines _MACRO_.
+
+*-v*,
+*--verbose*
+       Print verbose information - normally routine progress messages will
+       be displayed. Supply more than once to increase verbosity, eg. *-vv*.
+
+# DEBUG OPTIONS

"Debug" is not an operation, though. Should we still separate these options 
like that?

> +     proxy http server instead of the default port. This option may also
+       be specified by configuring the macro *%\_httpport*.
+
+# ENVIRONMENT
+*RPM_CONFIGDIR*
+       Used to override the default *rpm* configuration home,
+       typically _/usr/lib/rpm_.
+
+# EXIT STATUS
+On success, 0 is returned, a non-zero failure code otherwise.
+
+# FILES
+
+## rpmrc Configuration
+
+Each file in the colon separated rpmrc path is read sequentially by

Hmm, this might be tricky to reword since there's the "default rpmrc path" 
later in this section as well...

-- 
Reply to this email directly or view it on GitHub:
https://github.com/rpm-software-management/rpm/pull/3659#pullrequestreview-2702639958
You are receiving this because you are subscribed to this thread.

Message ID: <rpm-software-management/rpm/pull/3659/review/2702639...@github.com>
_______________________________________________
Rpm-maint mailing list
Rpm-maint@lists.rpm.org
https://lists.rpm.org/mailman/listinfo/rpm-maint

Reply via email to