[PATCH] man/man7/man-pages.7: Tell contributors to write titles in lowercase

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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 should have been written in
lowercase [1].  This commit corrects man-pages(7) so that it tells
contributors to use lowercase when writing titles on title lines.

[1]: <https://lore.kernel.org/linux-man/rph24kz36vysoeix4qoxxxcwq3c3fskws2vmxkkgcb2lpits3f@ysm7ug66svzh/T/#mc84250a6634d7f776118879021331001cceccbe5>
---
 man/man7/man-pages.7 | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/man/man7/man-pages.7 b/man/man7/man-pages.7
index dc117662f..49c02d3fd 100644
--- a/man/man7/man-pages.7
+++ b/man/man7/man-pages.7
@@ -95,8 +95,8 @@ .SS Title line
 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, written in lowercase (e.g.,
+.IR man-pages ).
 .TP
 .I section
 The section number in which the man page should be placed (e.g.,
-- 
2.47.0





[Index of Archives]     [Kernel Documentation]     [Netdev]     [Linux Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux