From nobody Wed Jul 27 09:13:54 2022 X-Original-To: doc@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4Lt7Pd11c6z4WrQ2 for ; Wed, 27 Jul 2022 09:13:57 +0000 (UTC) (envelope-from pauamma@gundo.com) Received: from mail.gundo.com (gibson.gundo.com [75.145.166.65]) by mx1.freebsd.org (Postfix) with ESMTP id 4Lt7Pc3bk0z4LbP for ; Wed, 27 Jul 2022 09:13:56 +0000 (UTC) (envelope-from pauamma@gundo.com) Received: from webmail.gundo.com (variax.gundo.com [75.145.166.70]) by mail.gundo.com (Postfix) with ESMTP id D65A54C12BF for ; Wed, 27 Jul 2022 04:13:54 -0500 (CDT) List-Id: Documentation project List-Archive: https://lists.freebsd.org/archives/freebsd-doc List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-freebsd-doc@freebsd.org MIME-Version: 1.0 Date: Wed, 27 Jul 2022 09:13:54 +0000 From: Pau Amma To: Doc Subject: Quotes around the .Nd argument in 1/6 of manual pages User-Agent: Roundcube Webmail/1.4.8 Message-ID: <7da2e497f241240f9e4433259158d3fb@gundo.com> X-Sender: pauamma@gundo.com Organization: The Cabal (TINC) Content-Type: text/plain; charset=US-ASCII; format=flowed Content-Transfer-Encoding: 7bit X-Rspamd-Queue-Id: 4Lt7Pc3bk0z4LbP X-Spamd-Bar: --- Authentication-Results: mx1.freebsd.org; dkim=none; dmarc=pass (policy=none) header.from=gundo.com; spf=pass (mx1.freebsd.org: domain of pauamma@gundo.com designates 75.145.166.65 as permitted sender) smtp.mailfrom=pauamma@gundo.com X-Spamd-Result: default: False [-4.00 / 15.00]; NEURAL_HAM_MEDIUM(-1.00)[-1.000]; NEURAL_HAM_LONG(-1.00)[-1.000]; NEURAL_HAM_SHORT(-1.00)[-1.000]; DMARC_POLICY_ALLOW(-0.50)[gundo.com,none]; R_SPF_ALLOW(-0.20)[+ip4:75.145.166.64/28]; RCVD_IN_DNSWL_MED(-0.20)[75.145.166.65:from]; RCVD_NO_TLS_LAST(0.10)[]; MIME_GOOD(-0.10)[text/plain]; RWL_MAILSPIKE_GOOD(-0.10)[75.145.166.65:from]; ASN(0.00)[asn:7922, ipnet:75.144.0.0/13, country:US]; FROM_EQ_ENVFROM(0.00)[]; R_DKIM_NA(0.00)[]; MLMMJ_DEST(0.00)[doc@freebsd.org]; MIME_TRACE(0.00)[0:+]; ARC_NA(0.00)[]; HAS_ORG_HEADER(0.00)[]; RCVD_COUNT_TWO(0.00)[2]; FROM_HAS_DN(0.00)[]; FREEFALL_USER(0.00)[pauamma]; TO_DN_ALL(0.00)[]; TO_MATCH_ENVRCPT_ALL(0.00)[]; RCPT_COUNT_ONE(0.00)[1]; PREVIOUSLY_DELIVERED(0.00)[doc@freebsd.org]; MID_RHS_MATCH_FROM(0.00)[] X-ThisMailContainsUnwantedMimeParts: N 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)