From: "Alejandro Colomar (man-pages)" <alx.manpages@gmail.com>
To: Peter Xu <peterx@redhat.com>
Cc: Mike Rapoport <rppt@linux.vnet.ibm.com>,
Nadav Amit <nadav.amit@gmail.com>,
linux-kernel@vger.kernel.org,
Linux MM Mailing List <linux-mm@kvack.org>,
Axel Rasmussen <axelrasmussen@google.com>,
Andrea Arcangeli <aarcange@redhat.com>,
Andrew Morton <akpm@linux-foundation.org>,
Michael Kerrisk <mtk.manpages@gmail.com>,
linux-man@vger.kernel.org
Subject: Re: [PATCH 1/4] userfaultfd.2: Add UFFD_FEATURE_THREAD_ID docs
Date: Thu, 4 Mar 2021 19:13:29 +0100 [thread overview]
Message-ID: <3e96f127-5dd0-28f7-4b86-1bf4e623bd06@gmail.com> (raw)
In-Reply-To: <20210304155019.GX397383@xz-x1>
Hi Peter,
On 3/4/21 4:50 PM, Peter Xu wrote:
> On Thu, Mar 04, 2021 at 10:22:18AM +0100, Alejandro Colomar (man-pages) wrote:
>>> +.BR UFFD_FEATURE_THREAD_ID
>>
>> This should use [.B] and not [.BR].
>> .BR is for alternate Bold and Roman.
>> .B is for bold.
>>
>> (There are more appearances of this in the other patches.)
>
> Yeah I got a bit confused when differenciating those two, since I also see
> similar usage, e.g.:
>
> .BR O_CLOEXEC
Yes, these are minor imperfections that got into the manual pages, and
we don't remove them due to the churn that it would create (and
possibility of introducing other bugs while doing such a big scripted
change that couldn't be easily reviewed (thousands of lines)). So as we
still have those lines, they tend to confuse.
>
> I'll fix all of them appeared in current patchset. Let me know if you also
> want me to fix all the existing uses of ".BR" too where ".B" would suffice.
> Otherwise I won't touch them since I can't say they're wrong either (I think
> most of them should generate the same output with either ".BR" or ".B" if
> there's only one word?).
Our current non-written guidelines are:
We are fixing the existing ones as we modify code near them,
but leave untouched code that is far from what we are changing, even on
the same page.
Thanks,
Alex
--
Alejandro Colomar
Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/
next prev parent reply other threads:[~2021-03-04 18:15 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-04 1:59 [PATCH 0/4] man2: udpate mm/userfaultfd manpages to latest Peter Xu
2021-03-04 1:59 ` [PATCH 1/4] userfaultfd.2: Add UFFD_FEATURE_THREAD_ID docs Peter Xu
2021-03-04 6:38 ` Mike Rapoport
2021-03-04 15:53 ` Peter Xu
2021-03-04 9:22 ` Alejandro Colomar (man-pages)
2021-03-04 15:50 ` Peter Xu
2021-03-04 18:13 ` Alejandro Colomar (man-pages) [this message]
2021-03-04 1:59 ` [PATCH 2/4] userfaultfd.2: Add write-protect mode Peter Xu
2021-03-04 6:46 ` Mike Rapoport
2021-03-04 16:02 ` Peter Xu
2021-03-04 1:59 ` [PATCH 3/4] ioctl_userfaultfd.2: Add UFFD_FEATURE_THREAD_ID docs Peter Xu
2021-03-04 1:59 ` [PATCH 4/4] ioctl_userfaultfd.2: Add write-protect mode docs Peter Xu
2021-03-04 16:12 ` Peter Xu
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=3e96f127-5dd0-28f7-4b86-1bf4e623bd06@gmail.com \
--to=alx.manpages@gmail.com \
--cc=aarcange@redhat.com \
--cc=akpm@linux-foundation.org \
--cc=axelrasmussen@google.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-man@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=mtk.manpages@gmail.com \
--cc=nadav.amit@gmail.com \
--cc=peterx@redhat.com \
--cc=rppt@linux.vnet.ibm.com \
/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 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.