diff options
| author | Jason Yundt <jason@jasonyundt.email> | 2025-01-14 16:14:25 -0500 |
|---|---|---|
| committer | Alejandro Colomar <alx@kernel.org> | 2025-01-15 00:24:26 +0100 |
| commit | 6eb4c25e3744c9ccbb68af70da1889594cc732b3 (patch) | |
| tree | 3396290dace9c5fc04f2aa331611a20df8016877 /man/man7 | |
| parent | 476bf6d993c13edf8a80c4e874a1d4bf6ff7eb45 (diff) | |
| download | man-pages-6eb4c25e3744c9ccbb68af70da1889594cc732b3.tar.gz | |
man/man7/man-pages.7: Stop telling contributors to write titles in all caps
Recently, I submitted my first patch to the Linux man-pages project. In
my patch, I had created a new manual page. On the manual page’s title
line, I had written the title of my new page in all caps because
man-pages(7) said that I should write it that way. It turns out that
man-pages(7) was wrong and that the title on the title line should have
matched the title in the manual page’s filename [1][2]. This commit
corrects man-pages(7) so that it does not tell contributors to use all
caps when writing titles on title lines.
Link: [1] <https://lore.kernel.org/linux-man/rph24kz36vysoeix4qoxxxcwq3c3fskws2vmxkkgcb2lpits3f@ysm7ug66svzh/T/#mc84250a6634d7f776118879021331001cceccbe5>
Link: [2] <https://lore.kernel.org/linux-man/mog6nnwzwl2dmlrec5b7l76wbxlsnklvdulok644x6o557trib@3zwtoz47r4x3/T/#mf71422d0e159210a7ca2798f2bba50a668e1410e>
Message-ID: <20250114211427.160509-1-jason@jasonyundt.email>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
Diffstat (limited to 'man/man7')
| -rw-r--r-- | man/man7/man-pages.7 | 3 |
1 files changed, 1 insertions, 2 deletions
diff --git a/man/man7/man-pages.7 b/man/man7/man-pages.7 index dc117662f3..0ba3991e81 100644 --- a/man/man7/man-pages.7 +++ b/man/man7/man-pages.7 @@ -95,8 +95,7 @@ command: The arguments of the command are as follows: .TP .I title -The title of the man page, written in all caps (e.g., -.IR MAN-PAGES ). +The title of the man page. .TP .I section The section number in which the man page should be placed (e.g., |