Re: Fwd: [PATCH] Man page section reference should be in uppercase

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

 



Nazri Ramliy <ayiehere@xxxxxxxxx> writes:

>        $ git grep '"[A-z ]\+" section'
>
> See how all of them use all-caps when referring to man page sections.

"TEMPLATE DIRECTORY" and "SPECIFYING REVISIONS" are shown quite often, but
there are some others that deviate from your "all caps" norm.  For
example, 'see the "Configuration Mechanism" section' appears in git.txt
and it matches how the section header that is referred to is spelled.

Also the section headers referred to in caps in the current documentation
set are indeed spelled in caps (grep for "TEMPLATE DIRECTORY" in
Documentation/git-init.txt for example).

Having said that, I wouldn't mind if the theme of your improvement were to
spell manual section *headers* in caps, instead of leaving the actual
section names still spelled as "Note about fast-forwards" and upcasing
only the reference(s) to it, which can make things inconsistent depending
on how the documentation is typeset (e.g. I read the documentation source
as text files).  Obviously the resulting patchset may also have to upcase
e.g. "combined diff format" section header to bring consistency into the
whole documentation set, not just the "Note about fast-forwards" section.

--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]