option sort order in usage/man pages/documentation
Hi, I'm working on some man page updates, and, thinking about consistency, been wondering if there's any policy set on the order of options that one should use in usage messages/man pages/other documentation, i.e. is it 'ABCabc', 'AaBbCc', or 'aAbBcC' (or anything else really, I hope 'unsorted' isn't possible answer here). ___ freebsd-doc@freebsd.org mailing list https://lists.freebsd.org/mailman/listinfo/freebsd-doc To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"
Re: option sort order in usage/man pages/documentation
On 2018-08-30 03:50, Yuri Pankov wrote: > Hi, > > I'm working on some man page updates, and, thinking about consistency, > been wondering if there's any policy set on the order of options that > one should use in usage messages/man pages/other documentation, i.e. is > it 'ABCabc', 'AaBbCc', or 'aAbBcC' (or anything else really, I hope > 'unsorted' isn't possible answer here). > ___ > freebsd-doc@freebsd.org mailing list > https://lists.freebsd.org/mailman/listinfo/freebsd-doc > To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org" It has definitely been policy to sort them alphabetically, but I don't know that that much attention has ever been paid to sorting upper and lower case characters. ABCabc is right out, but I don't know what the right answer is between the other two. I would say humans sort lowercase first, but by ASCII the uppercase is first. -- Allan Jude signature.asc Description: OpenPGP digital signature
[Bug 204414] ThunderX vnic driver missing man page
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=204414 Ed Maste changed: What|Removed |Added Blocks|203349 |231027 --- Comment #2 from Ed Maste --- Move to 13.x tracking PR - if we're able to take on work for the Cavium Octeon TX family (i.e., basically embedded ThunderX) this issue will be investigated as part of that work. Referenced Bugs: https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=203349 [Bug 203349] [META] FreeBSD Foundation sponsored project dependencies for FreeBSD 11.x https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=231027 [Bug 231027] [META] FreeBSD-Foundation sponsored issues for FreeBSD 13-CURRENT -- You are receiving this mail because: You are the assignee for the bug. You are on the CC list for the bug. ___ freebsd-doc@freebsd.org mailing list https://lists.freebsd.org/mailman/listinfo/freebsd-doc To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"
[Bug 191607] Inconsistent documentation on entering the debugger
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=191607 Ed Maste changed: What|Removed |Added Blocks||231027 Referenced Bugs: https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=231027 [Bug 231027] [META] FreeBSD-Foundation sponsored issues for FreeBSD 13-CURRENT -- You are receiving this mail because: You are the assignee for the bug. ___ freebsd-doc@freebsd.org mailing list https://lists.freebsd.org/mailman/listinfo/freebsd-doc To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"
Re: option sort order in usage/man pages/documentation
On Thu, Aug 30, 2018 at 10:25:21AM -0400, Allan Jude wrote: > On 2018-08-30 03:50, Yuri Pankov wrote: > > Hi, > > > > I'm working on some man page updates, and, thinking about consistency, > > been wondering if there's any policy set on the order of options that > > one should use in usage messages/man pages/other documentation, i.e. is > > it 'ABCabc', 'AaBbCc', or 'aAbBcC' (or anything else really, I hope > > 'unsorted' isn't possible answer here). > > ___ > > freebsd-doc@freebsd.org mailing list > > https://lists.freebsd.org/mailman/listinfo/freebsd-doc > > To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org" > > It has definitely been policy to sort them alphabetically, but I don't > know that that much attention has ever been paid to sorting upper and > lower case characters. > > ABCabc is right out, but I don't know what the right answer is between > the other two. I would say humans sort lowercase first, but by ASCII the > uppercase is first. POSIX locale collation behavior is probably going to be the default winner in this question. Though I think there are some cases where it is better to group related options than to globally do everything alphabetically. -Ben signature.asc Description: PGP signature
