Re: Is it "GIT" or "Git" or "git"? Standardize documentation?
- From
Andreas Ericsson <ae@op5.se>
- Date
- Dec 14, 2011, 01:01 UTC
- Message-ID
- <4EE7F561.2040601@op5.se>
- In-Reply-To
- <20111214004332.GA8464@thinkpad>
On 12/14/2011 01:43 AM, Sebastian Morr wrote:
Show 9 quoted lines
> 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.
> 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.
-- Andreas Ericsson andreas.ericsson@op5.se 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.