Re: sorting "See also" cross-references? (was: [PATCH] ioctl_pipe.2: Add.)

Alejandro Colomar <alx.manpages@xxxxxxxxx> · Thu, 9 Jun 2022 10:41:41 +0200

Hi Branden!

On 6/8/22 22:26, G. Branden Robinson wrote:
Hi Alex!

At 2022-06-08T17:12:19+0200, Alejandro Colomar wrote:
+.SH SEE ALSO
+.BR pipe (2),
+.BR ioctl (2)

| sort

[...]
In the groff man pages, I try to order these cross references in a
considered way, starting with the page that I consider most "important"
or likely to fruitfully follow up the topic for the reader.  That sort
of judgment is subjective, of course, but with a well curated man page
corpus, I think it's likely more useful than a mechanical sort.

Makes sense.  Most pages have lexicographic order, but importance order 
seems an improvement.

Cheers,

Alex

--
Alejandro Colomar
Linux man-pages comaintainer; http://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/
Attachment:
OpenPGP_signature

Description: OpenPGP digital signature