Errors in man pages, here: proc(5): Punctuation/Spacing

Errors in man pages, here: proc(5): Punctuation/Spacing

[Helge Kreutzmann]

Dear manpages maintainers.
the manpage-l10n project maintains a large number of translations of
man pages both from a large variety of sources (including manpages) 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 translate 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. As requested, each
issue is sent in an unique mail for easier tracking on your side. If
future reports should use another channel, please let me know.

**

Full stop at end?

"(B<CONFIG_TRANSPARENT_HUGEPAGE> is required.)  Memory used by shared memory "
"(shmem) and B<tmpfs>(5)  allocated with huge pages"

--
Missing closing bracket

msgid "I<softirq> (since Linux 2.6.0"

--
Missing space 1GB → 1 GB

"This file can be used to query and set the run-time limit on the maximum "
"(System V IPC) shared memory segment size that can be created.  Shared "
"memory segments up to 1GB are now supported in the kernel.  This value "
"defaults to B<SHMMAX>."

--
Missing full stop

msgid "Enable memory failure recovery (when supported by the platform)"

--
s/processes, This/processes. This/

"Specifies an amount of memory (in KiB) to reserve for user processes, This "
"is intended to prevent a user from starting a single memory hogging process, "
"such that they cannot recover (kill the hog).  The value in this file has an "
"effect only when I</proc/sys/vm/overcommit_memory> is set to 2 (\"overcommit "
"never\" mode).  In this case, the system reserves an amount of memory that "
"is the minimum of [3% of current process size, I<user_reserve_kbytes>]."
--
display → displays

"This file display information about memory zones.  This is useful for "
"analyzing virtual memory behavior."

-- 
      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/

Re: Errors in man pages, here: proc(5): Punctuation/Spacing

[Michael Kerrisk (man-pages)]

On 4/19/20 8:48 AM, Helge Kreutzmann wrote:
> Dear manpages maintainers.
> the manpage-l10n project maintains a large number of translations of
> man pages both from a large variety of sources (including manpages) 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 translate 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. As requested, each
> issue is sent in an unique mail for easier tracking on your side. If
> future reports should use another channel, please let me know.
> 
> **
> 
> Full stop at end?
> 
> "(B<CONFIG_TRANSPARENT_HUGEPAGE> is required.)  Memory used by shared memory "
> "(shmem) and B<tmpfs>(5)  allocated with huge pages"

Fixed.

> --
> Missing closing bracket
> 
> msgid "I<softirq> (since Linux 2.6.0"


Fixed.

> --
> Missing space 1GB → 1 GB
> 
> "This file can be used to query and set the run-time limit on the maximum "
> "(System V IPC) shared memory segment size that can be created.  Shared "
> "memory segments up to 1GB are now supported in the kernel.  This value "
> "defaults to B<SHMMAX>."

Fixed.


> --
> Missing full stop
> 
> msgid "Enable memory failure recovery (when supported by the platform)"

Fixed.

> 
> --
> s/processes, This/processes. This/

Fixed.

> "Specifies an amount of memory (in KiB) to reserve for user processes, This "
> "is intended to prevent a user from starting a single memory hogging process, "
> "such that they cannot recover (kill the hog).  The value in this file has an "
> "effect only when I</proc/sys/vm/overcommit_memory> is set to 2 (\"overcommit "
> "never\" mode).  In this case, the system reserves an amount of memory that "
> "is the minimum of [3% of current process size, I<user_reserve_kbytes>]."
> --
> display → displays

Fixed.

> "This file display information about memory zones.  This is useful for "
> "analyzing virtual memory behavior."

Thanks,

Michael

-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/