Linux-man Archive on lore.kernel.org
 help / color / Atom feed
* Errors in man pages, here: wprintf(3): Wording
@ 2020-04-19  6:48 Helge Kreutzmann
  2020-04-20  9:44 ` Michael Kerrisk (man-pages)
  0 siblings, 1 reply; 4+ messages in thread
From: Helge Kreutzmann @ 2020-04-19  6:48 UTC (permalink / raw)
  To: mtk.manpages; +Cc: linux-man

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.

**

The text in the bracket in the 2nd sentence is difficult to understand

"If no B<l> modifier is present: the I<const\\ char\\ *> argument is expected "
"to be a pointer to an array of character type (pointer to a string) "
"containing a multibyte character sequence beginning in the initial shift "
"state.  Characters from the array are converted to wide characters (each by "
"a call to the B<mbrtowc>(3)  function with a conversion state starting in "
"the initial state before the first byte).  The resulting wide characters are "
"written up to (but not including) the terminating null wide character (L\\(aq"
"\\e0\\(aq).  If a precision is specified, no more wide characters than the "
"number specified are written.  Note that the precision determines the number "
"of I<wide characters> written, not the number of I<bytes> or I<screen "
"positions>.  The array must contain a terminating null byte (\\(aq"
"\\e0\\(aq), unless a precision is given and it is so small that the number "
"of converted wide characters reaches it before the end of the array is "
"reached.  If an B<l> modifier is present: the I<const\\ wchar_t\\ *> "
"argument is expected to be a pointer to an array of wide characters.  Wide "
"characters from the array are written up to (but not including) a "
"terminating null wide character.  If a precision is specified, no more than "
"the number specified are written.  The array must contain a terminating null "
"wide character, unless a precision is given and it is smaller than or equal "
"to the number of wide characters in the array."

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

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: Errors in man pages, here: wprintf(3): Wording
  2020-04-19  6:48 Errors in man pages, here: wprintf(3): Wording Helge Kreutzmann
@ 2020-04-20  9:44 ` Michael Kerrisk (man-pages)
  2020-04-26 16:30   ` Helge Kreutzmann
  0 siblings, 1 reply; 4+ messages in thread
From: Michael Kerrisk (man-pages) @ 2020-04-20  9:44 UTC (permalink / raw)
  To: Helge Kreutzmann; +Cc: mtk.manpages, linux-man

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.
> 
> **
> 
> The text in the bracket in the 2nd sentence is difficult to understand

I need a bit more elaboration here.

Thanks,

Michael

> "If no B<l> modifier is present: the I<const\\ char\\ *> argument is expected "
> "to be a pointer to an array of character type (pointer to a string) "
> "containing a multibyte character sequence beginning in the initial shift "
> "state.  Characters from the array are converted to wide characters (each by "
> "a call to the B<mbrtowc>(3)  function with a conversion state starting in "
> "the initial state before the first byte).  The resulting wide characters are "
> "written up to (but not including) the terminating null wide character (L\\(aq"
> "\\e0\\(aq).  If a precision is specified, no more wide characters than the "
> "number specified are written.  Note that the precision determines the number "
> "of I<wide characters> written, not the number of I<bytes> or I<screen "
> "positions>.  The array must contain a terminating null byte (\\(aq"
> "\\e0\\(aq), unless a precision is given and it is so small that the number "
> "of converted wide characters reaches it before the end of the array is "
> "reached.  If an B<l> modifier is present: the I<const\\ wchar_t\\ *> "
> "argument is expected to be a pointer to an array of wide characters.  Wide "
> "characters from the array are written up to (but not including) a "
> "terminating null wide character.  If a precision is specified, no more than "
> "the number specified are written.  The array must contain a terminating null "
> "wide character, unless a precision is given and it is smaller than or equal "
> "to the number of wide characters in the array."
> 


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

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: Errors in man pages, here: wprintf(3): Wording
  2020-04-20  9:44 ` Michael Kerrisk (man-pages)
@ 2020-04-26 16:30   ` Helge Kreutzmann
  2020-04-27  8:45     ` Jakub Wilk
  0 siblings, 1 reply; 4+ messages in thread
From: Helge Kreutzmann @ 2020-04-26 16:30 UTC (permalink / raw)
  To: Michael Kerrisk (man-pages); +Cc: linux-man


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

Hallo Michael,
On Mon, Apr 20, 2020 at 11:44:19AM +0200, Michael Kerrisk (man-pages) wrote:
> On 4/19/20 8:48 AM, Helge Kreutzmann wrote:
> > The text in the bracket in the 2nd sentence is difficult to understand
> 
> I need a bit more elaboration here.

Please close this issue, cannot reproduce. Sorry for the noise.

But I noticed another possible issue when reading the text: Is the 
(L\\(aq\\e0\\(aq) korrekt? Is the "L" supposed to be some markup?

> > "If no B<l> modifier is present: the I<const\\ char\\ *> argument is expected "
> > "to be a pointer to an array of character type (pointer to a string) "
> > "containing a multibyte character sequence beginning in the initial shift "
> > "state.  Characters from the array are converted to wide characters (each by "
> > "a call to the B<mbrtowc>(3)  function with a conversion state starting in "
> > "the initial state before the first byte).  The resulting wide characters are "
> > "written up to (but not including) the terminating null wide character (L\\(aq"
> > "\\e0\\(aq).  If a precision is specified, no more wide characters than the "
> > "number specified are written.  Note that the precision determines the number "
> > "of I<wide characters> written, not the number of I<bytes> or I<screen "
> > "positions>.  The array must contain a terminating null byte (\\(aq"
> > "\\e0\\(aq), unless a precision is given and it is so small that the number "
> > "of converted wide characters reaches it before the end of the array is "
> > "reached.  If an B<l> modifier is present: the I<const\\ wchar_t\\ *> "
> > "argument is expected to be a pointer to an array of wide characters.  Wide "
> > "characters from the array are written up to (but not including) a "
> > "terminating null wide character.  If a precision is specified, no more than "
> > "the number specified are written.  The array must contain a terminating null "
> > "wide character, unless a precision is given and it is smaller than or equal "
> > "to the number of wide characters in the array."

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

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: Errors in man pages, here: wprintf(3): Wording
  2020-04-26 16:30   ` Helge Kreutzmann
@ 2020-04-27  8:45     ` Jakub Wilk
  0 siblings, 0 replies; 4+ messages in thread
From: Jakub Wilk @ 2020-04-27  8:45 UTC (permalink / raw)
  To: Helge Kreutzmann; +Cc: Michael Kerrisk, linux-man

* Helge Kreutzmann <debian@helgefjell.de>, 2020-04-26, 18:30:
>But I noticed another possible issue when reading the text: Is the 
>(L\\(aq\\e0\\(aq) korrekt? Is the "L" supposed to be some markup?

In the source that is:

   L\(aq\e0\(aq

which is rendered by groff as

   L'\0'

which is C syntax for null wide character:
https://en.cppreference.com/w/c/language/character_constant

-- 
Jakub Wilk

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, back to index

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-04-19  6:48 Errors in man pages, here: wprintf(3): Wording Helge Kreutzmann
2020-04-20  9:44 ` Michael Kerrisk (man-pages)
2020-04-26 16:30   ` Helge Kreutzmann
2020-04-27  8:45     ` Jakub Wilk

Linux-man Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-man/0 linux-man/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-man linux-man/ https://lore.kernel.org/linux-man \
		linux-man@vger.kernel.org
	public-inbox-index linux-man

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-man


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git