Re: [Rpm-maint] Fwd: Errors in rpm man pages

2020-06-10 Thread Helge Kreutzmann
Hello rpm maintainers,
On Sat, May 09, 2020 at 11:27:01AM +0200, Helge Kreutzmann wrote:
> I'm now reporting the errors for your project. If future reports should
> use another channel, please let me know.

As I'm not a developer, I intend to unsubscribe soon. If you have any
question do not hesitate to contact me directly.

Greetings

 Helge


-- 
  Dr. Helge Kreutzmann deb...@helgefjell.de
   Dipl.-Phys.   http://www.helgefjell.de/debian.php
64bit GNU powered gpg signed mail preferred
   Help keep free software "libre": http://www.ffii.de/


signature.asc
Description: PGP signature
___
Rpm-maint mailing list
Rpm-maint@lists.rpm.org
http://lists.rpm.org/mailman/listinfo/rpm-maint


[Rpm-maint] Fwd: Errors in rpm man pages

2020-05-09 Thread Helge Kreutzmann
Dear rpm maintainers,
(please see also the NOTE at the end)

the manpage-l10n project maintains a large number of translations of
man pages both from a large variety of sources (including rpm) as
well for a large variety of target languages.

During their work translators notice different possible issues in the
original (english) man pages. Sometiems this is a straightforward
typo, sometimes a hard to read sentence, sometimes this is a
convention not held up and sometimes we simply do not understand the
original.

We use several distributions as sources and update regularly (at
least every 2 month). This means we are fairly recent (some
distributions like archlinux also update frequently) but might miss
the latest upstream version once a while, so the error might be
already fixed. We apologize and ask you to close the issue immediately
if this should be the case, but given the huge volume of projects and
the very limited number of volunteers we are not able to double check
each and every issue.

Secondly we translators see the manpages in the neutral po format,
i.e. converted and harmonized, but not the original source (be it man,
groff, xml or other). So we cannot provide a true patch (where
possible), but only an approximation which you need to convert into
your source format.

Finally the issues I'm reporting have accumulated over time and are
not always discovered by me, so sometimes my description of the
problem my be a bit limited - do not hesitate to ask so we can clarify
them.

I'm now reporting the errors for your project. If future reports should
use another channel, please let me know.

Man page: rpm2archive.8
Issue: archive archive? By default rpm contains a cpio archive. Maybe
   archive archive → cpio archive

"rpm2archive - Extract archive archive from RPM Package Manager (RPM) package."
--
Man page: rpmbuild.8
Issue: B<> → I<>

"One of the following basic modes must be selected: B, B, B, B."
--
Man page: rpmbuild.8
Issue: Missing full stop

"Use the database in I rather than the default path I"
--
Man page: rpmbuild.8
Issue: Missing markup for chroot(2)

"Use the file system tree rooted at I for all operations.  Note "
"that this means the database within I will be used for dependency "
"checks and any scriptlet(s) (e.g.  B<%post> if installing, or B<%prep> if "
"building, a package)  will be run after a chroot(2) to I."
--
Man page: rpmbuild.8
Issue: Missing markup for rpm

"The general form of an rpm build command is"

"There are two other ways to invoke building with rpm:"
--
Man page: rpmbuild.8
Issue: Missing markup for %prep etc.

"Build binary and source packages (after doing the %prep, %build, and "
"%install stages)."

"Build a binary package (after doing the %prep, %build, and %install stages)."

"Executes the \"%prep\" stage from the spec file. Normally this involves "
"unpacking the sources and applying any patches."

"Do not execute %prep build stage even if present in spec."
--
Man page: rpmbuild.8
Issue: Missing markup for stage names and "make" commands

"Do the \"%build\" stage from the spec file (after doing the %prep stage).  "
"This generally involves the equivalent of a \"make\"."

"Do the \"%install\" stage from the spec file (after doing the %prep and "
"%build stages).  This generally involves the equivalent of a \"make install"
"\"."
--
Man page: rpmbuild.8
Issue: Missing markup for %files

"Do a \"list check\".  The \"%files\" section from the spec file is macro "
"expanded, and checks are made to verify that each file exists."
--
Man page: rpmbuild.8
Issue: .. → .

"Do not generate debuginfo packages.."
--
Man page: rpmbuild.8
Issue: eg. → e.g.

"Remove the spec file after the build (may also be used standalone, eg. "
"\"B B<--rmspec foo.spec>\")."
--
Man page: rpmbuild.8
Issue: Missing markup for _builddir, -n, untar, %setup, buildSubdir

"Build from locally checked out sources. Sets _builddir to current working "
"directory. Skips handling of -n and untar in the %setup and the deletion of "
"the buildSubdir."
--
Man page: rpmbuild.8
Issue: It is uncommon to have explicit line break in SEE ALSO entries

"B(1),\n"
"B(3),\n"
"B(8),\n"
"B(8),\n"
"B(8)\n"
"B(8),\n"
"B(8),\n"
--
Man page: rpmbuild.8
Issue: Missing markup for %autosetup

"Select the I to use with %autosetup, if one is not set in the spec "
"file.  Note that not all values for I, e.g., B (the default) and "
"B, B, or B work interchangeably with all other patches "
"and options stated in the %autosetup line, especially option B<-p>I."
--
Man page: rpmdb.8
Issue: It is uncommon to have explicit line break in SEE ALSO entries

"B(3),\n"
"B(8),\n"
"B(8),\n"
"B(8),\n"
"B(8),\n"
"B(8),\n"
"B(8),\n"
--
Man page: rpmdiff.1
Issue: The difference between checksum and digest is unclear

" S (size)\n"
" M (mode)\n"
" 5 (checksum)\n"
" D (device)\n"
" N (inode)\n"
" L (number of links)\n"
" V (vflags)\n"
" U (user)\n"
" G (group)\n"
" F (digest)\n"
" T (time)\n"
--
Man page: rpmdiff.1
Issue: The special