All of lore.kernel.org
 help / color / mirror / Atom feed
* Errors in man pages, here: signal.2
@ 2021-07-25 17:09 Helge Kreutzmann
  2021-07-25 21:02 ` Michael Kerrisk (man-pages)
  0 siblings, 1 reply; 6+ messages in thread
From: Helge Kreutzmann @ 2021-07-25 17:09 UTC (permalink / raw)
  To: mtk.manpages; +Cc: linux-man

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

Dear Linux manpages maintainer,
the manpage-l10n project maintains a large number of translations of
man pages both from a large variety of sources (including Linux
Manpages) 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: signal.2
Issue: Such paragraphs shouldn't be no-wrap

"B<WARNING>:\n"
" the behavior of\n"
"B<signal>()\n"
"varies across UNIX versions,\n"
"and has also varied historically across different versions of Linux.\n"
"B<Avoid its use>: use\n"
"B<sigaction>(2)\n"
"instead.\n"
"See I<Portability> below.\n"

-- 
      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] 6+ messages in thread

* Re: Errors in man pages, here: signal.2
  2021-07-25 17:09 Errors in man pages, here: signal.2 Helge Kreutzmann
@ 2021-07-25 21:02 ` Michael Kerrisk (man-pages)
  2021-07-27 19:03   ` Jakub Wilk
  0 siblings, 1 reply; 6+ messages in thread
From: Michael Kerrisk (man-pages) @ 2021-07-25 21:02 UTC (permalink / raw)
  To: Helge Kreutzmann; +Cc: linux-man

Hello Helge,

> Man page: signal.2
> Issue: Such paragraphs shouldn't be no-wrap
>
> "B<WARNING>:\n"
> " the behavior of\n"
> "B<signal>()\n"
> "varies across UNIX versions,\n"
> "and has also varied historically across different versions of Linux.\n"
> "B<Avoid its use>: use\n"
> "B<sigaction>(2)\n"
> "instead.\n"
> "See I<Portability> below.\n"

I don't understand this report, and can't see a problem. Please elaborate.

Thanks,

Michael

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

* Re: Errors in man pages, here: signal.2
  2021-07-25 21:02 ` Michael Kerrisk (man-pages)
@ 2021-07-27 19:03   ` Jakub Wilk
  2021-08-10  1:46     ` Michael Kerrisk (man-pages)
  0 siblings, 1 reply; 6+ messages in thread
From: Jakub Wilk @ 2021-07-27 19:03 UTC (permalink / raw)
  To: Michael Kerrisk; +Cc: Helge Kreutzmann, linux-man

* Michael Kerrisk <mtk.manpages@gmail.com>, 2021-07-25, 23:02:
>>Man page: signal.2
>>Issue: Such paragraphs shouldn't be no-wrap
>>
>>"B<WARNING>:\n"
>>" the behavior of\n"
>>"B<signal>()\n"
>>"varies across UNIX versions,\n"
>>"and has also varied historically across different versions of Linux.\n"
>>"B<Avoid its use>: use\n"
>>"B<sigaction>(2)\n"
>>"instead.\n"
>>"See I<Portability> below.\n"
>
>I don't understand this report, and can't see a problem. Please 
>elaborate.

I think the problem is that the spurious space before "the behavior" is 
confusing po4a.

-- 
Jakub Wilk

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

* Re: Errors in man pages, here: signal.2
  2021-07-27 19:03   ` Jakub Wilk
@ 2021-08-10  1:46     ` Michael Kerrisk (man-pages)
  2021-08-10  8:26       ` G. Branden Robinson
  2021-08-17 13:41       ` Helge Kreutzmann
  0 siblings, 2 replies; 6+ messages in thread
From: Michael Kerrisk (man-pages) @ 2021-08-10  1:46 UTC (permalink / raw)
  To: Jakub Wilk; +Cc: mtk.manpages, Helge Kreutzmann, linux-man

On 7/27/21 9:03 PM, Jakub Wilk wrote:
> * Michael Kerrisk <mtk.manpages@gmail.com>, 2021-07-25, 23:02:
>>> Man page: signal.2
>>> Issue: Such paragraphs shouldn't be no-wrap
>>>
>>> "B<WARNING>:\n"
>>> " the behavior of\n"
>>> "B<signal>()\n"
>>> "varies across UNIX versions,\n"
>>> "and has also varied historically across different versions of Linux.\n"
>>> "B<Avoid its use>: use\n"
>>> "B<sigaction>(2)\n"
>>> "instead.\n"
>>> "See I<Portability> below.\n"
>>
>> I don't understand this report, and can't see a problem. Please 
>> elaborate.
> 
> I think the problem is that the spurious space before "the behavior" is 
> confusing po4a.

Thanks, Jakub. I fixed that.

Cheers,

Michael



-- 
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] 6+ messages in thread

* Re: Errors in man pages, here: signal.2
  2021-08-10  1:46     ` Michael Kerrisk (man-pages)
@ 2021-08-10  8:26       ` G. Branden Robinson
  2021-08-17 13:41       ` Helge Kreutzmann
  1 sibling, 0 replies; 6+ messages in thread
From: G. Branden Robinson @ 2021-08-10  8:26 UTC (permalink / raw)
  To: Michael Kerrisk (man-pages); +Cc: Jakub Wilk, Helge Kreutzmann, linux-man

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

At 2021-08-10T03:46:23+0200, Michael Kerrisk (man-pages) wrote:
> On 7/27/21 9:03 PM, Jakub Wilk wrote:
> > * Michael Kerrisk <mtk.manpages@gmail.com>, 2021-07-25, 23:02:
> >>> Man page: signal.2
> >>> Issue: Such paragraphs shouldn't be no-wrap
> >>>
> >>> "B<WARNING>:\n"
> >>> " the behavior of\n"
> >>> "B<signal>()\n"
> >>> "varies across UNIX versions,\n"
[...]
> >>
> >> I don't understand this report, and can't see a problem. Please
> >> elaborate.
> > 
> > I think the problem is that the spurious space before "the behavior"
> > is confusing po4a.
> 
> Thanks, Jakub. I fixed that.

My interpretation would be not that po4a was getting confused, but that
it was taking roff(7) language input at its word, where the default
semantics of a leading space in filled text are that it causes a break
and indents the line by however many spaces are present.

Here's some material from the groff Texinfo manual in the forthcoming
1.23.0 release.

[[
A blank input line not only causes a break, but by default it also
outputs a one-line vertical space (effectively a blank output line).
This behavior can be modified; see *note Blank Line Traps::.  Macro
packages may discourage or disable the blank line method of paragraphing
in favor of their own macros.

A line that begins with one or more spaces causes a break.  The spaces
are output at the beginning of the next line without being _adjusted_
(see below); however, this behavior can be modified (*note Leading Space
Traps::).  Again, macro packages may provide other methods of producing
indented paragraphs.  Trailing spaces on text lines are ignored.(1)
(*note Breaking-Footnote-1::)
]]

I've changed the groff man(7) macro package to install traps to warn of
blank lines and filled lines with leading spaces if the CHECKSTYLE
register is set to a value of 3 or greater.

Here's an example of style-checking the signal.2 page as of commit
1d767b55 (22 March) with groff in development.

$ ./groff/build/test-groff -Tutf8 -man -rCHECKSTYLE=3 -z man-pages/man2/signal.2
an.tmac:man-pages/man2/signal.2:49: style: 1 leading space(s) on input line
an.tmac:man-pages/man2/signal.2:163: style: .BR expects at least 2 arguments, got 1
an.tmac:man-pages/man2/signal.2:179: style: .BR expects at least 2 arguments, got 1
an.tmac:man-pages/man2/signal.2:254: style: .BR expects at least 2 arguments, got 1

The register has to be set to enable style checking; the above
diagnostics will not be presented to innocent man page readers.

Regards,
Branden

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

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

* Re: Errors in man pages, here: signal.2
  2021-08-10  1:46     ` Michael Kerrisk (man-pages)
  2021-08-10  8:26       ` G. Branden Robinson
@ 2021-08-17 13:41       ` Helge Kreutzmann
  1 sibling, 0 replies; 6+ messages in thread
From: Helge Kreutzmann @ 2021-08-17 13:41 UTC (permalink / raw)
  To: Michael Kerrisk (man-pages); +Cc: Jakub Wilk, linux-man

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

Hello Michael,
On Tue, Aug 10, 2021 at 03:46:23AM +0200, Michael Kerrisk (man-pages) wrote:
> On 7/27/21 9:03 PM, Jakub Wilk wrote:
> > * Michael Kerrisk <mtk.manpages@gmail.com>, 2021-07-25, 23:02:
> >>> Man page: signal.2
> >>> Issue: Such paragraphs shouldn't be no-wrap
> >>>
> >>> "B<WARNING>:\n"
> >>> " the behavior of\n"
> >>> "B<signal>()\n"
> >>> "varies across UNIX versions,\n"
> >>> "and has also varied historically across different versions of Linux.\n"
> >>> "B<Avoid its use>: use\n"
> >>> "B<sigaction>(2)\n"
> >>> "instead.\n"
> >>> "See I<Portability> below.\n"
> >>
> >> I don't understand this report, and can't see a problem. Please 
> >> elaborate.
> > 
> > I think the problem is that the spurious space before "the behavior" is 
> > confusing po4a.
> 
> Thanks, Jakub. I fixed that.

Thanks for fixing.

I'm not sure if this is the cause, but there are lots of forced line
breaks ("the \n") in this paragraph, which is quite unusual.

I look at the next version on this again, and might come back, but for
now consider this one fixed.

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] 6+ messages in thread

end of thread, other threads:[~2021-08-17 13:41 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-07-25 17:09 Errors in man pages, here: signal.2 Helge Kreutzmann
2021-07-25 21:02 ` Michael Kerrisk (man-pages)
2021-07-27 19:03   ` Jakub Wilk
2021-08-10  1:46     ` Michael Kerrisk (man-pages)
2021-08-10  8:26       ` G. Branden Robinson
2021-08-17 13:41       ` Helge Kreutzmann

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.