[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Quilt-dev] [patch v2 12/26] Man page: update internal and external
From: |
G. Branden Robinson |
Subject: |
Re: [Quilt-dev] [patch v2 12/26] Man page: update internal and external cross-references |
Date: |
Tue, 26 Jul 2022 11:38:06 -0500 |
Hi Jean,
At 2022-07-26T14:43:20+0200, Jean Delvare wrote:
> Embolden internal subsection reference, and refer to its parent
> section.
In the groff man pages I do not use boldface for section or subsection
cross references; instead I use simple quotation (that is, I surround
the (sub)section title with \[lq] and \[rq] special character escape
sequences to get "typographer's quotes" where possible). Just FYI; you
may not want to join this convention. I have been strongly tempted to
add a "Q" macro to groff_man(7) to make this and other uses of quotation
easier.
> Sort man page cross-reference list in alphabetical order.
In the past 4-5 years I have come to no longer endorse this practice, at
least not when done robotically.
https://lore.kernel.org/linux-man/a2009ae6-7f51-f7c5-e108-f0c89a17a963@gmail.com/T/#md95904290a511f674762328f22813aa891e67978
However, if the man pages listed are co-equal in relevance and
importance, alphabetical order does no harm.
Regards,
Branden
signature.asc
Description: PGP signature
- [Quilt-dev] [patch v2 04/26] Man page: reorganize sections, (continued)
- [Quilt-dev] [patch v2 04/26] Man page: reorganize sections, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 05/26] Man page: use font macros instead of font escapes, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 06/26] Man page: use groff_man(7)s EX and EE macros for examples, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 07/26] Man page: escape ASCII hyphen-minus characters used as such, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 08/26] Man page: make synopsis comprehensive, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 09/26] Man page: use character escapes for directional quotes and spacing tilde, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 10/26] Man page: use "e.g." correctly, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 11/26] Man page: italicize work titles, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 12/26] Man page: update internal and external cross-references, Jean Delvare, 2022/07/26
- Re: [Quilt-dev] [patch v2 12/26] Man page: update internal and external cross-references,
G. Branden Robinson <=
- [Quilt-dev] [patch v2 13/26] Man page: set filespecs and environment variable names in italics, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 14/26] Man page: document -h flag in the Options section, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 15/26] Man page: capitalize "PDF" when not part of a filename, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 16/26] Man page: render Andreas Gruenbachers name with a u-umlaut, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 17/26] Man page: tighten summary, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 18/26] Man page: change the form of the word "subdirectory", Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 19/26] Man page: sort options in alphabetical order to ease human scanning, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 20/26] Man page: wordsmith Description section, Jean Delvare, 2022/07/26