From: "G. Branden Robinson" <firstname.lastname@example.org> To: "Alejandro Colomar (man-pages)" <email@example.com> Cc: "Mickaël Salaün" <firstname.lastname@example.org>, "Jann Horn" <email@example.com>, "Jonathan Corbet" <firstname.lastname@example.org>, "Kees Cook" <email@example.com>, "Randy Dunlap" <firstname.lastname@example.org>, "Vincent Dagonneau" <email@example.com>, firstname.lastname@example.org, email@example.com, firstname.lastname@example.org, email@example.com, "Mickaël Salaün" <firstname.lastname@example.org>, "Michael Kerrisk" <email@example.com> Subject: Re: [PATCH v2 1/4] landlock.7: Add a new page to introduce Landlock Date: Fri, 30 Jul 2021 08:01:31 +1000 [thread overview] Message-ID: <firstname.lastname@example.org> (raw) In-Reply-To: <email@example.com> [-- Attachment #1: Type: text/plain, Size: 4651 bytes --] Hi, Alex! [regrets for the huge CC--those not interested in English/linux-man style issues can skip this] At 2021-07-29T16:56:37+0200, Alejandro Colomar (man-pages) wrote: > On 7/12/21 5:57 PM, Mickaël Salaün wrote: > > +For instance, one process's thread may apply Landlock rules to itself, > > s/process's/process'/ Many English language authorities would disagree with you, but I'll skip digging up citations to them because the Linux man-pages project's practice is already firmly in the other direction. $ git grep "s's\>" | wc -l 322 Moreover, "process's" is extensively attested as most of those... $ git grep "process's" | wc -l 320 ...and a global change in the opposite direction from your recommendation is credited to mtk in the Changes.old file. $ grep -B2 "process' " Changes.old |head -n 3 A few files mtk s/process' /process's/ Finding examples of the opposite practice is complicated by the use of apostrophes as single quotes (these usually _aren't_ confounded by code examples, however, since it would be incorrect C language syntax to quote a string literal with them). There are many such occurrences in Changes.old; I'll skip them. The remainder are few enough that I'll quote them here. $ git grep -E "s'(\s|$)" man* man2/adjtimex.2:Linux uses David L.\& Mills' clock adjustment algorithm (see RFC\ 5905). man2/move_pages.2:.\" FIXME Describe the result if pointers in the 'pages' array are man2/utimensat.2:.\" given a 'times' array in which both tv_nsec fields are UTIME_NOW, which man2/utimensat.2:.\" provides equivalent functionality to specifying 'times' as NULL, the man3/getaddrinfo.3:.\" 2008-02-26, mtk; clarify discussion of NULL 'hints' argument; other man3/printf.3:thousands' grouping character is used. man3/printf.3:the output is to be grouped with thousands' grouping characters man3/printf.3:.\" no thousands' separator, no NaN or infinity, no "%m$" and "*m$". man3/scanf.3:This specifies that the input number may include thousands' man3/xdr.3:the array elements' C form, and their external man3/xdr.3:the array elements' C form, and their external man5/elf.5:The array element is unused and the other members' values are undefined. man5/proc.5:under the default overcommit 'guess' mode (i.e., 0 in man5/proc.5:because other nodes' memory may be free, man7/bootparam.7:The Linux kernel accepts certain 'command-line options' or 'boot time man7/bootparam.7:parameters' at the moment it is started. man7/bootparam.7:The option 'reboot=bios' will man7/bootparam.7:A SCSI device can have a number of 'subdevices' contained within man7/hier.7:Users' mailboxes. man7/mount_namespaces.7:the root directory under several users' home directories. man7/uri.7:schemes; see those tools' documentation for information on those schemes. man7/uri.7:detects the users' environment (e.g., text or graphics, man8/ld.so.8:and do not apply to those objects' children, Of the above, 1. most are correct uses of the English plural possessive ("nodes'"); 2. a few occur in comments, where they're fine if present as commentary--if they're "commented out" chunks of man page source, they should follow man page formatting rules in the event they require "resurrection"; 3. we see some uses of apostrophes as quotation marks; and 4. David L. Mills's name is marked as a plural possessive. The application of apostrophe+s to singular proper names ending in "s" is a debated issue, and there is probably some room for personal preference on the part of the bearer of the name. Two side issues: A. Regarding point 3, I'd say this illustrates advantages of using special character escape sequences like \[lq] and \[rq] for quotation. First, you will get paired quotation marks in UTF-8, PDF, and HTML output. Second, you won't encounter false positives in searches like the above. Third, you semantically enrich the content. On the downside, adopting special character escapes would likely mean having to choose between U.S. and U.K. quotation styles. B. Regarding another active thread we're in, I observe man2/adjtimex.2:Linux uses David L.\& Mills' clock adjustment algorithm (see RFC\ 5905). as another case where \~ recommends itself over "\ "; this isn't even a code example, and it illustrates the desirability of decoupling non-breaking from participation in space adjustment. Popping the stack, have I persuaded you on the plural possessive front? :) Best regards, Branden  https://man7.org/linux/man-pages/man7/groff_char.7.html (search for "the apostrophe") [-- Attachment #2: signature.asc --] [-- Type: application/pgp-signature, Size: 833 bytes --]
next prev parent reply other threads:[~2021-07-29 22:01 UTC|newest] Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top 2021-07-12 15:57 [PATCH v2 0/4] Add Landlock man pages Mickaël Salaün 2021-07-12 15:57 ` [PATCH v2 1/4] landlock.7: Add a new page to introduce Landlock Mickaël Salaün 2021-07-29 14:56 ` Alejandro Colomar (man-pages) 2021-07-29 22:01 ` G. Branden Robinson [this message] 2021-07-29 22:34 ` Alejandro Colomar (man-pages) 2021-07-30 12:15 ` Mickaël Salaün 2021-07-30 12:41 ` Alejandro Colomar (man-pages) 2021-07-30 12:59 ` Alejandro Colomar (man-pages) 2021-07-30 14:32 ` Mickaël Salaün 2021-07-31 0:15 ` G. Branden Robinson 2021-07-31 11:02 ` Alejandro Colomar (man-pages) 2021-07-30 23:39 ` G. Branden Robinson 2021-07-31 10:51 ` Alejandro Colomar (man-pages) 2021-07-31 13:48 ` G. Branden Robinson 2021-07-12 15:57 ` [PATCH v2 2/4] landlock_create_ruleset.2: Document new syscall Mickaël Salaün 2021-07-12 15:57 ` [PATCH v2 3/4] landlock_add_rule.2: " Mickaël Salaün 2021-07-12 15:57 ` [PATCH v2 4/4] landlock_restrict_self.2: " Mickaël Salaün
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 \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --subject='Re: [PATCH v2 1/4] landlock.7: Add a new page to introduce Landlock' \ /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
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).