Issues in man pages of btrfs-progs

Issues in man pages of btrfs-progs

[Helge Kreutzmann]

[-- Attachment #1: Type: text/plain, Size: 5571 bytes --]

Dear btrfs-progs maintainer,
the manpage-l10n project maintains a large number of translations of
man pages both from a large variety of sources (including btrfs-progs) 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: btrfs.8
Issue:    B<btrfs(5)> → B<btrfs>(5)

"For other topics (mount options, etc) please refer to the separate manual "
"page B<btrfs(5)>\\&."
--
Man page: btrfs.8
Issue:    B<btrfs-balance(8)> → B<btrfs-balance>(8)

"Balance btrfs filesystem chunks across single or several devices.  See "
"B<btrfs-balance(8)> for details."
--
Man page: btrfs.8
Issue:    B<btrfs-check(8)> → B<btrfs-check>(8)

"Do off-line check on a btrfs filesystem.  See B<btrfs-check(8)> for details."
--
Man page: btrfs.8
Issue:    B<btrfs-device(8)> → B<btrfs-device>(8)

"Manage devices managed by btrfs, including add/delete/scan and so on.  See "
"B<btrfs-device(8)> for details."
--
Man page: btrfs.8
Issue:    B<btrfs-filesystem(8)> → B<btrfs-filesystem>(8)

"Manage a btrfs filesystem, including label setting/sync and so on.  See "
"B<btrfs-filesystem(8)> for details."
--
Man page: btrfs.8
Issue:    B<btrfs-inspect-internal(8)> → B<btrfs-inspect-internal>(8)

"Debug tools for developers/hackers.  See B<btrfs-inspect-internal(8)> for "
"details."
--
Man page: btrfs.8
Issue:    B<btrfs-property(8)> → B<btrfs-property>(8)

"Get/set a property from/to a btrfs object.  See B<btrfs-property(8)> for "
"details."
--
Man page: btrfs.8
Issue:    B<btrfs-qgroup(8)> → B<btrfs-qgroup>(8)

"Manage quota group(qgroup) for btrfs filesystem.  See B<btrfs-qgroup(8)> for "
"details."
--
Man page: btrfs.8
Issue:    B<btrfs-quota(8)> and B<btrfs-qgroup(8)> → B<btrfs-quota>(8) and B<btrfs-qgroup>(8)

"Manage quota on btrfs filesystem like enabling/rescan and etc.  See B<btrfs-"
"quota(8)> and B<btrfs-qgroup(8)> for details."
--
Man page: btrfs.8
Issue:    B<btrfs-receive(8)> → B<btrfs-receive>(8)

"Receive subvolume data from stdin/file for restore and etc.  See B<btrfs-"
"receive(8)> for details."
--
Man page: btrfs.8
Issue:    B<btrfs-replace(8)> → B<btrfs-replace>(8)

"Replace btrfs devices.  See B<btrfs-replace(8)> for details."
--
Man page: btrfs.8
Issue:    B<btrfs-rescue(8)> → B<btrfs-rescue>(8)

"Try to rescue damaged btrfs filesystem.  See B<btrfs-rescue(8)> for details."
--
Man page: btrfs.8
Issue:    B<btrfs-restore(8)> → B<btrfs-restore>(8)

"Try to restore files from a damaged btrfs filesystem.  See B<btrfs-"
"restore(8)> for details."
--
Man page: btrfs.8
Issue:    B<btrfs-scrub(8)> → B<btrfs-scrub>(8)

"Scrub a btrfs filesystem.  See B<btrfs-scrub(8)> for details."
--
Man page: btrfs.8
Issue:    B<btrfs-send(8)> → B<btrfs-send>(8)

"Send subvolume data to stdout/file for backup and etc.  See B<btrfs-send(8)> "
"for details."
--
Man page: btrfs.8
Issue:    B<btrfs-subvolume(8)> → B<btrfs-subvolume>(8)

"Create/delete/list/manage btrfs subvolume.  See B<btrfs-subvolume(8)> for "
"details."
--
Man page: btrfs.8
Issue:    btrfs wiki I<\\%http://btrfs.wiki.kernel.org> → E<.UR https://btrfs.wiki.kernel.org>btrfs wiki<.UE> (Note: https)A

"B<btrfs> is part of btrfs-progs.  Please refer to the btrfs wiki I<\\%http://"
"btrfs.wiki.kernel.org> for further details."
--
Man page: btrfs.8
Issue:    section number in such links must not be bold: B<btrfs(5)> → B<btrfs>(5) etc.

"B<btrfs(5)>, B<btrfs-balance(8)>, B<btrfs-check(8)>, B<btrfs-convert(8)>, "
"B<btrfs-device(8)>, B<btrfs-filesystem(8)>, B<btrfs-inspect-internal(8)>, "
"B<btrfs-property(8)>, B<btrfs-qgroup(8)>, B<btrfs-quota(8)>, B<btrfs-"
"receive(8)>, B<btrfs-replace(8)>, B<btrfs-rescue(8)>, B<btrfs-restore(8)>, "
"B<btrfs-scrub(8)>, B<btrfs-send(8)>, B<btrfs-subvolume(8)>, B<btrfstune(8)>, "
"B<mkfs.btrfs(8)>"

-- 
      Dr. Helge Kreutzmann                     debian@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/

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: Issues in man pages of btrfs-progs

[David Sterba]

Hi,

On Mon, Jul 18, 2022 at 04:14:47PM +0200, Helge Kreutzmann wrote:
> Dear btrfs-progs maintainer,
> the manpage-l10n project maintains a large number of translations of
> man pages both from a large variety of sources (including btrfs-progs) 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.

I've opened an issue https://github.com/kdave/btrfs-progs/issues/495
please continue there. Sending reports by mail also works.

> Man page: btrfs.8
> Issue:    B<btrfs(5)> → B<btrfs>(5)

So all the issues are for the manual page references and placement of
the section. The manual pages written RST still lack references to many
other things (issue #476) but the manual page references are a bit
special so there's a separate issue for that. Also for you to follow up
and report anything else you find.

The idea is to use some macros so we don't have to format the references
manually, but I'm lacking the knowledge how to do that in RST.

Re: Issues in man pages of btrfs-progs

[Helge Kreutzmann]

[-- Attachment #1: Type: text/plain, Size: 697 bytes --]

Hello David,
Am Mon, Mar 04, 2024 at 07:22:52PM +0100 schrieb David Sterba:
> On Sun, Mar 03, 2024 at 12:33:20PM +0000, Helge Kreutzmann wrote:
> If there's a validation tool that would identify such problems I can add
> it to the documentation build pipeline or at least to the CI. Please let
> me know.

None that I know of, sorry.

Thanks for the swift handling.

Greetings

       Helge

-- 
      Dr. Helge Kreutzmann                     debian@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/

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: Issues in man pages of btrfs-progs

[David Sterba]

On Sun, Mar 03, 2024 at 12:33:20PM +0000, Helge Kreutzmann wrote:
> Dear brtfs maintainer,
> the manpage-l10n project maintains a large number of translations of
> man pages both from a large variety of sources (including btrfs) 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: btrfs.8
> Issue:    I<\\%btrfs(5)> → B<\\%btrfs>(5)

Thanks for the report, I've opened an issue
https://github.com/kdave/btrfs-progs/issues/756 , looks like it's namely
formatting of the manual page references. There was a recent change that
added a common formatting macro so this can be fixed in one go.

If there's a validation tool that would identify such problems I can add
it to the documentation build pipeline or at least to the CI. Please let
me know.

Issues in man pages of btrfs-progs

[Helge Kreutzmann]

[-- Attachment #1: Type: text/plain, Size: 6148 bytes --]

Dear brtfs maintainer,
the manpage-l10n project maintains a large number of translations of
man pages both from a large variety of sources (including btrfs) 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: btrfs.8
Issue:    I<\\%btrfs(5)> → B<\\%btrfs>(5)

"For other topics (mount options, etc) please refer to the separate manual "
"page I<\\%btrfs(5)>\\&."
--
Man page: btrfs.8
Issue 1:  I<\\%numfmt(1)> → B<\\%numfmt>(1)
Issue 2:  I<\\%locale(7)> → B<\\%locale>(7)

"I<Sizes>, both upon input and output, can be expressed in either SI or IEC-I "
"units (see I<\\%numfmt(1)>)  with the suffix I<B> appended.  All numbers "
"will be formatted according to the rules of the I<C> locale (ignoring the "
"shell locale, see I<\\%locale(7)>)."
--
Man page: btrfs.8
Issue:    I<\\%btrfs-balance(8)> → B<btrfs-balance>(8)

"Balance btrfs filesystem chunks across single or several devices.  See I<\\"
"%btrfs-balance(8)> for details."
--
Man page: btrfs.8
Issue:    I<\\%btrfs-check(8)> → B<btrfs-check>(8)

"Do off-line check on a btrfs filesystem.  See I<\\%btrfs-check(8)> for "
"details."
--
Man page: btrfs.8
Issue:    I<\\%btrfs-device(8)> → B<btrfs-device>(8)

"Manage devices managed by btrfs, including add/delete/scan and so on.  See "
"I<\\%btrfs-device(8)> for details."
--
Man page: btrfs.8
Issue:    I<\\%btrfs-filesystem(8)> → B<\\%btrfs-filesystem>(8)

"Manage a btrfs filesystem, including label setting/sync and so on.  See I<\\"
"%btrfs-filesystem(8)> for details."
--
Man page: btrfs.8
Issue:    I<\\%btrfs-inspect-internal(8)> → B<\\%btrfs-inspect-internal>(8)

"Debug tools for developers/hackers.  See I<\\%btrfs-inspect-internal(8)> for "
"details."
--
Man page: btrfs.8
Issue:    I<\\%btrfs-property(8)> → B<\\%btrfs-property>(8)

"Get/set a property from/to a btrfs object.  See I<\\%btrfs-property(8)> for "
"details."
--
Man page: btrfs.8
Issue:   I<\\%btrfs-qgroup(8)> → B<\\%btrfs-qgroup>(8)

"Manage quota group(qgroup) for btrfs filesystem.  See I<\\%btrfs-qgroup(8)> "
"for details."
--
Man page: btrfs.8
Issue:    I<\\%btrfs-quota(8)> and I<\\%btrfs-qgroup(8)> → B<\\%btrfs-quota>(8) and B<\\%btrfs-qgroup>(8)

"Manage quota on btrfs filesystem like enabling/rescan and etc.  See I<\\"
"%btrfs-quota(8)> and I<\\%btrfs-qgroup(8)> for details."
--
Man page: btrfs.8
Issue:    I<\\%btrfs-receive(8)> → B<\\%btrfs-receive>(8)

"Receive subvolume data from stdin/file for restore and etc.  See I<\\%btrfs-"
"receive(8)> for details."
--
Man page: btrfs.8
Issue:    I<\\%btrfs-replace(8)> → B<\\%btrfs-replace>(8)

"Replace btrfs devices.  See I<\\%btrfs-replace(8)> for details."
--
Man page: btrfs.8
Issue:    I<\\%btrfs-rescue(8)> → B<\\%btrfs-rescue>(8)

"Try to rescue damaged btrfs filesystem.  See I<\\%btrfs-rescue(8)> for "
"details."
--
Man page: btrfs.8
Issue:    I<\\%btrfs-restore(8)> → B<\\%btrfs-restore>(8)

"Try to restore files from a damaged btrfs filesystem.  See I<\\%btrfs-"
"restore(8)> for details."
--
Man page: btrfs.8
Issue:    I<\\%btrfs-scrub(8)> → B<\\%btrfs-scrub>(8)

"Scrub a btrfs filesystem.  See I<\\%btrfs-scrub(8)> for details."
--
Man page: btrfs.8
Issue:    I<\\%btrfs-send(8)> → B<\\%btrfs-send>(8)

"Send subvolume data to stdout/file for backup and etc.  See I<\\%btrfs-"
"send(8)> for details."
--
Man page: btrfs.8
Issue:    I<\\%btrfs-subvolume(8)> → B<\\%btrfs-subvolume>(8)

"Create/delete/list/manage btrfs subvolume.  See I<\\%btrfs-subvolume(8)> for "
"details."
--
Man page: btrfs.8
Issue:    btrfs wiki I<\\%http://btrfs.wiki.kernel.org> → E<.UR http://btrfs.wiki.kernel.org>btrfs wiki<.UE> (Note: https)

"B<btrfs> is part of btrfs-progs.  Please refer to the documentation at I<\\"
"%https://btrfs.readthedocs.io>\\&."
--
Man page: btrfs.8
Issue:    section number in such links must not be bold: I<btrfs(5)> → B<btrfs>(5) etc.

"I<\\%btrfs(5)>, I<\\%btrfs-balance(8)>, I<\\%btrfs-check(8)>, I<\\%btrfs-"
"convert(8)>, I<\\%btrfs-device(8)>, I<\\%btrfs-filesystem(8)>, I<\\%btrfs-"
"inspect-internal(8)>, I<\\%btrfs-property(8)>, I<\\%btrfs-qgroup(8)>, I<\\"
"%btrfs-quota(8)>, I<\\%btrfs-receive(8)>, I<\\%btrfs-replace(8)>, I<\\%btrfs-"
"rescue(8)>, I<\\%btrfs-restore(8)>, I<\\%btrfs-scrub(8)>, I<\\%btrfs-"
"send(8)>, I<\\%btrfs-subvolume(8)>, I<\\%btrfstune(8)>, I<\\%mkfs.btrfs(8)>"

-- 
      Dr. Helge Kreutzmann                     debian@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/

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]