Hi Padraig, On 1/2/21 1:23 PM, Pádraig Brady wrote: > The man viewer has enough context to highlight these references as > appropriate, > so we shouldn't be explicitly specifying style.
Hmm, 'man' on my system doesn't show them in bold, and neither does the HTML view via 'man -H'. Does it do for you? man(1) and man-pages(7) explicitly mark the SEE ALSO entries as bold, so that seems to be the general direction. So I'm 55:45 for using the explicit variant. One ML reader (Mingye Wang) wrote to me privately that he would also recommend the bold formatting. FWIW: if we'd consider changing to bold: the syntax-check rule 'sc_prohibit_man_see_also_period' only works with '\fB...\fP' entries in one line, while having each entry in a separate '.BR' line would be easier to read. > I also agree with the cat(1) reference, > so +1 to the whole patch. Thanks. To have the formatting consistent for now, I've wrapped the diff into a proper patch (attached). Feel free to apply. Thanks & have a nice day, Berny
>From ec9a5b8396dbb035d2e87102260ff1ba8288a815 Mon Sep 17 00:00:00 2001 From: Bernhard Voelker <m...@bernhard-voelker.de> Date: Sat, 2 Jan 2021 14:57:03 +0100 Subject: [PATCH] doc: make formatting of SEE ALSO in cat.1 and tac.1 consistent None of the coreutils man pages - but the two above - are using bold setting for the references to other man pages in the SEE ALSO section. * man/cat.x (SEE ALSO): Remove '\fB...\fP' setting. * man/tac.x: Likewise, and add a reference to cat(1). --- man/cat.x | 2 +- man/tac.x | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/man/cat.x b/man/cat.x index b84600fbd..9eb38cf05 100644 --- a/man/cat.x +++ b/man/cat.x @@ -3,4 +3,4 @@ cat \- concatenate files and print on the standard output [DESCRIPTION] .\" Add any additional description here [SEE ALSO] -\fBtac\fP(1) +tac(1) diff --git a/man/tac.x b/man/tac.x index 66bd338ec..677da2f82 100644 --- a/man/tac.x +++ b/man/tac.x @@ -3,4 +3,4 @@ tac \- concatenate and print files in reverse [DESCRIPTION] .\" Add any additional description here [SEE ALSO] -\fBrev\fP(1) +cat(1), rev(1) -- 2.29.2
