Re: [PATCH v2] man/man7/man-pages.7: Stop telling contributors to write titles in all caps

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

 



Hi Jason,

On Tue, Jan 14, 2025 at 04:14:25PM -0500, Jason Yundt wrote:
> 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.
> 
> [1]: <https://lore.kernel.org/linux-man/rph24kz36vysoeix4qoxxxcwq3c3fskws2vmxkkgcb2lpits3f@ysm7ug66svzh/T/#mc84250a6634d7f776118879021331001cceccbe5>
> [2]: <https://lore.kernel.org/linux-man/mog6nnwzwl2dmlrec5b7l76wbxlsnklvdulok644x6o557trib@3zwtoz47r4x3/T/#mf71422d0e159210a7ca2798f2bba50a668e1410e>
> ---
> This new version of the patch removes the ", written in ..." part like
> Alex suggested.

Thanks!  I've applied this patch:
<https://www.alejandro-colomar.es/src/alx/linux/man-pages/man-pages.git/commit/?h=contrib&id=6eb4c25e3744c9ccbb68af70da1889594cc732b3>

Cheers,
Alex

> 
>  man/man7/man-pages.7 | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
> 
> diff --git a/man/man7/man-pages.7 b/man/man7/man-pages.7
> index dc117662f..0ba3991e8 100644
> --- a/man/man7/man-pages.7
> +++ b/man/man7/man-pages.7
> @@ -95,8 +95,7 @@ .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.
>  .TP
>  .I section
>  The section number in which the man page should be placed (e.g.,
> -- 
> 2.47.0
> 

-- 
<https://www.alejandro-colomar.es/>

Attachment: signature.asc
Description: PGP signature


[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