Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 27 Jul 2022 09:13:54 +0000
From:      Pau Amma <pauamma@gundo.com>
To:        Doc <doc@freebsd.org>
Subject:   Quotes around the .Nd argument in 1/6 of manual pages
Message-ID:  <7da2e497f241240f9e4433259158d3fb@gundo.com>

next in thread | raw e-mail | index | archive | help
The examples in 
https://docs.freebsd.org/en/books/fdp-primer/manual-pages/#manual-pages-sample-structures 
use quotes around the .Nd argument, but only about 1/6 of actual manual 
pages (outside contrib/) use them:

~/FreeBSD/src% git grep -E '^\.Nd "[^ ]* ' | grep -v -E '^contrib/' | wc 
-l # .Nd "foo bar"
      615
~/FreeBSD/src% git grep -E '^\.Nd [^"][^ ]* ' | grep -v -E '^contrib/' | 
wc -l # .Nd baz quux
     2683
~/FreeBSD/src% git grep -E '^\.Nd ' | grep -v -E '^contrib/' | wc -l # 
.Nd
     3320

Unless some manual pages need the quotes or there are other reasons to 
keep them, I'm planning -to align the manual pages to the quoteless form 
and adjust the FDP primer accordingly. Opinions?

-- 
#BlackLivesMatter #TransWomenAreWomen #AccessibilityMatters 
#StandWithUkrainians
English: he/him/his (singular they/them/their/theirs OK)
French: il/le/lui (iel/iel and ielle/ielle OK)
Tagalog: siya/niya/kaniya (please avoid sila/nila/kanila)




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?7da2e497f241240f9e4433259158d3fb>