Re: [PATCH 1/4] userfaultfd.2: Add UFFD_FEATURE_THREAD_ID docs

Alejandro Colomar (man-pages)
2021-03-04T18:15:08Z

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/