Bug#1005512: irqtop: Errors in man pages
Hello Axel, On Thu, Jun 15, 2023 at 01:07:12AM +0200, Axel Beckert wrote: > > Man page: irqtop.1 > > Issue:enouth → enough > > "enouth" neither is nor ever was in this Debian package. > > > "Show per-cpu statistics by specified mode. Available modes are: B, " > > "B, B. The default option B detects the width of " > > "window, then shows the per-cpu statistics if the width of window is large " > > "enouth to show a full line of statistics." > > Neither is this text. > > A quick search on codesearch.debian.net reveals that this is part of > the man page from the _other_ tool named irqtop, the one from > util-linux: > https://sources.debian.org/src/util-linux/2.38.1-5/sys-utils/irqtop.1.adoc/?hl=29#L29 > > Which is not yet shipped in a binary package in Debian as I didn't > manage to start the migration between the two irqtops timely before > the Bookworm freeze. > > Please report that error against src:util-linux. We reported this upstream: https://github.com/util-linux/util-linux/pull/2318 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
Bug#1005512: irqtop: Errors in man pages
Hello Axel, On Thu, Jun 15, 2023 at 01:07:12AM +0200, Axel Beckert wrote: > thanks for the bug report! You are welcome. > Helge Kreutzmann wrote: > > 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. > > Yeah, I think that's the place where things went a bit wrong. > > > Man page: irqtop.1 > > Issue:ethtool → B(8) > > I'm sorry, but this is a groff-written man page, but your suggested > change seems POD syntax. That is correct. At manpages-l10n we do not see the original syntax but only the "normalized" output as produced by po4a. So kindly translate this back to groff. > > "show extra eth stats (from ethtool)" > > That line now renders in man like this: > > "show extra eth stats (from B(8))" > > I don't think that's wanted. That is exactly as wanted. See man-pages(7) for the traditional formating conventions. > Besides we render htop(1) and friends under "SEE ALSO" also without > any special formatting. Then this should be changed there as well. You can check many other man pages who do. > So I'll make it simply "ethtool(8)". Maybe reconsider this (globally)? Please not that there are tools out there which can identify the B(8) and create appropriate hyperlinks; moreover it is good to spot those links in the text. > > Man page: irqtop.1 > > Issue:enouth → enough > > "enouth" neither is nor ever was in this Debian package. That is correct, that is only present in the version from Fedora 38. Upstream told me, that the man page comes from Debian. Apologies if Fedora is shipping a different man page. As downstream this is sometimes hard to spot where a specific text is actually originating from. > > "Show per-cpu statistics by specified mode. Available modes are: B, " > > "B, B. The default option B detects the width of " > > "window, then shows the per-cpu statistics if the width of window is large " > > "enouth to show a full line of statistics." > > Neither is this text. That's right, this is comming from Fedora again. > A quick search on codesearch.debian.net reveals that this is part of > the man page from the _other_ tool named irqtop, the one from > util-linux: > https://sources.debian.org/src/util-linux/2.38.1-5/sys-utils/irqtop.1.adoc/?hl=29#L29 > > Which is not yet shipped in a binary package in Debian as I didn't > manage to start the migration between the two irqtops timely before > the Bookworm freeze. > > Please report that error against src:util-linux. Thanks for pointing this out. Potentially for Fedora the util-linux version is (already) shipped. I'll forward this appropriately. Thanks for checking! 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
Bug#1005512: irqtop: Errors in man pages
Hi Helge, thanks for the bug report! Helge Kreutzmann wrote: > 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. Yeah, I think that's the place where things went a bit wrong. > Man page: irqtop.1 > Issue:ethtool → B(8) I'm sorry, but this is a groff-written man page, but your suggested change seems POD syntax. > "show extra eth stats (from ethtool)" That line now renders in man like this: "show extra eth stats (from B(8))" I don't think that's wanted. Besides we render htop(1) and friends under "SEE ALSO" also without any special formatting. So I'll make it simply "ethtool(8)". > Man page: irqtop.1 > Issue:enouth → enough "enouth" neither is nor ever was in this Debian package. > "Show per-cpu statistics by specified mode. Available modes are: B, " > "B, B. The default option B detects the width of " > "window, then shows the per-cpu statistics if the width of window is large " > "enouth to show a full line of statistics." Neither is this text. A quick search on codesearch.debian.net reveals that this is part of the man page from the _other_ tool named irqtop, the one from util-linux: https://sources.debian.org/src/util-linux/2.38.1-5/sys-utils/irqtop.1.adoc/?hl=29#L29 Which is not yet shipped in a binary package in Debian as I didn't manage to start the migration between the two irqtops timely before the Bookworm freeze. Please report that error against src:util-linux. Regards, Axel -- ,''`. | Axel Beckert , https://people.debian.org/~abe/ : :' : | Debian Developer, ftp.ch.debian.org Admin `. `' | 4096R: 2517 B724 C5F6 CA99 5329 6E61 2FF9 CD59 6126 16B5 `-| 1024D: F067 EA27 26B9 C3FC 1486 202E C09E 1D89 9593 0EDE
Bug#1005512: irqtop: Errors in man pages
Package: irqtop Severity: minor Tags: patch l10n Dear irqtop maintainer, the manpage-l10n project maintains a large number of translations of man pages both from a large variety of sources (including irqtop) as well for a large variety of target languages. During their work translators notice different possible issues in the original (english) man pages. Sometimes 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 in 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: irqtop.1 Issue:ethtool → B(8) "show extra eth stats (from ethtool)" -- Man page: irqtop.1 Issue:enouth → enough "Show per-cpu statistics by specified mode. Available modes are: B, " "B, B. The default option B detects the width of " "window, then shows the per-cpu statistics if the width of window is large " "enouth to show a full line of statistics." -- 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
