Skip to contentSkip to conversation

Is it "GIT" or "Git" or "git"? Standardize documentation?

DISCUSSION Sebastian Morr 3 participants 3 messages Jun 15, 2016

lore
Share & tools
lore
#0 lore raw

Okay, I'd like to hear opinions on this before creating a patch.

My perception is that "Git" is the name of the software, whereas "git" is used to refer to the actual command. But "GIT" is all over the documentation as well, most prominently at the top of README. Would anyone mind if we replaced all occurrences of "GIT" in the documentation with "Git"?
I suppose the release notes shouldn't be touched for historical reasons.

Completely unrelated: Why is it "Documentation/RelNotes" and not something like "documentation/release-notes"? Almost everything else is spelled either all-lower- or all-uppercase.

Sorry for being such a nazi...

#1 lore raw
Quoted 9 lines · Sebastian Morr

Okay, I'd like to hear opinions on this before creating a patch.

My perception is that "Git" is the name of the software, whereas "git" is used to refer to the actual command. But "GIT" is all over the documentation as well, most prominently at the top of README. Would anyone mind if we replaced all occurrences of "GIT" in the documentation with "Git"?
I suppose the release notes shouldn't be touched for historical reasons.

I doubt anyone cares all that much. I for one have absolutely no clue what you're talking about, but if you think it looks better one way than the other and care about it enough, just make the patch and send it in for review. Consensus is never reached before there's code, and hardly ever after either, but discussing something that *might* happen and still doesn't affect my daily life feels utterly pointless.

Quoted 4 lines

Completely unrelated: Why is it "Documentation/RelNotes" and not something like "documentation/release-notes"? Almost everything else is spelled either all-lower- or all-uppercase.

For tab-completion and directory listing reasons. Uppercase-D+tab puts you in the right directory and uppercasing RelNotes makes it easy to find among its many companions in that directory. It's fairly standard procedure in the unix world to uppercase or camelcase the more important documents, and especially when there's more than a small handful of files in a single directory.

Signature · 7 lines
Andreas Ericsson                   [email protected]
OP5 AB                             www.op5.se
Tel: +46 8-230225                  Fax: +46 8-230231

Considering the successes of the wars on alcohol, poverty, drugs and
terror, I think we should give some serious thought to declaring war
on peace.
#2 lore raw
In reply to Sebastian Morr
Quoted 4 lines · Sebastian Morr

Okay, I'd like to hear opinions on this before creating a patch.

My perception is that "Git" is the name of the software, whereas "git" is used to refer to the actual command.

And "GIT" is used interchangeably with "Git" whenever the document author feels like it warrants a bit more visibility than usual in the context. Think of it as typesetting in a font with small-caps or something ;-).