git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
Junio C Hamano <gitster@pobox.com>
Date
May 27, 2010, 19:50 UTC
Message-ID
<7v4ohtp1ja.fsf@alter.siamese.dyndns.org>
In-Reply-To
<AANLkTingglKSMHOcHXTg3hGF_czcFsnWLTd3GuSp-Mm6@mail.gmail.com>
Nazri Ramliy <ayiehere@gmail.com> 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.

Previous: Nazri Ramliy
Message 4 of 4 in “Man page section reference should be in uppercase”
  1. Man page section reference should be in uppercaseNazri Ramliy, May 25, 2010
  2. Dévai TamásMay 25, 2010
  3. Fwd: [PATCH] Man page section reference should be in uppercaseNazri Ramliy, May 26, 2010
  4. Junio C HamanoMay 27, 2010

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.