linux-man.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>
To: Jakub Wilk <jwilk@jwilk.net>
Cc: Helge Kreutzmann <debian@helgefjell.de>,
	linux-man <linux-man@vger.kernel.org>
Subject: Re: Errors in man pages, here: setpgid.2.po: Inconsistent formatting
Date: Tue, 21 Apr 2020 11:51:33 +0200	[thread overview]
Message-ID: <CAKgNAkjnSnd3LYEua_29CQN8vgk2Eo3OwgnqH3BwcsJZiiaY7A@mail.gmail.com> (raw)
In-Reply-To: <20200421083410.pmnkvk5fetjqfywd@jwilk.net>

Hello Jakub,

On Tue, 21 Apr 2020 at 10:34, Jakub Wilk <jwilk@jwilk.net> wrote:
>
> * Michael Kerrisk (man-pages) <mtk.manpages@gmail.com>, 2020-04-20, 08:12:
> >># FIXME: inconsistant formatting/markup (compared to previous entries)
> >>
> >>"B<pid_t getpgrp(pid_t >I<pid>B<);\\ \\ \\ \\ \\ \\ \\ \\ \\ \\ \\ > /* BSD "
> >>"version */"
> >
> >I need more context here. I can't see the problem.
>
> I think it's about comment indentation:
> for the BSD functions, it's done with escaped spaces:
>
>    .BI "pid_t getpgrp(pid_t " pid ");\ \ \ \ \ \ \ \ \ \ \ "
>    /* BSD version */
>
> whereas for the other functions, plain spaces are used:
>
>    .BR "pid_t getpgrp(void);" "                 /* POSIX.1 version */"

D'oh! What idiot formatted things like tha... ohhhh....

> While we can't just remove backslashes, we could do something like this:
>
>    .BI "pid_t getpgrp(pid_t " pid ");\fR            /* BSD version */"
>
> This is more readable IMO, and should make translators happy. :)

Agreed. Changed as you suggest.

Thanks,

Michael

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

      reply	other threads:[~2020-04-21  9:51 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-19  6:48 Errors in man pages, here: setpgid.2.po: Inconsistent formatting Helge Kreutzmann
2020-04-20  6:12 ` Michael Kerrisk (man-pages)
2020-04-21  8:34   ` Jakub Wilk
2020-04-21  9:51     ` Michael Kerrisk (man-pages) [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CAKgNAkjnSnd3LYEua_29CQN8vgk2Eo3OwgnqH3BwcsJZiiaY7A@mail.gmail.com \
    --to=mtk.manpages@gmail.com \
    --cc=debian@helgefjell.de \
    --cc=jwilk@jwilk.net \
    --cc=linux-man@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).