Re: [PATCH v3 2/6] Change 'git' to 'Git' whenever the whole system is referred to #1
From: Junio C Hamano <hidden>
Date: 2016-06-15 22:55:51
Thomas Ackermann [off-list ref] writes:
Signed-off-by: Thomas Ackermann <redacted> ---
quoted hunk
diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index 9f42c0d..14bdbbb 100644 --- a/Documentation/git-clean.txt +++ b/Documentation/git-clean.txt@@ -33,7 +33,7 @@ OPTIONS -f:: --force:: - If the git configuration variable clean.requireForce is not set + If the Git configuration variable clean.requireForce is not set to false, 'git clean' will refuse to run unless given -f or -n.
Before this description, -d option talks about a different Git repository; s/git/Git/ is needed there.
quoted hunk
diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 597048b..47d9880 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt@@ -214,7 +214,7 @@ objects from the source repository into a pack in the cloned repository. Instead of placing the cloned repository where it is supposed to be, place the cloned repository at the specified directory, then make a filesytem-agnostic git symbolic link to there.
Shouldn't this be "Git symbolic link"?
quoted hunk
diff --git a/Documentation/Makefile b/Documentation/Makefile index 971977b..a7a4f75 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile@@ -347,7 +347,7 @@ install-webdoc : html '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST) # You must have a clone of git-htmldocs and git-manpages repositories -# next to the git repository itself for the following to work. +# next to the Git repository itself for the following to work. quick-install: quick-install-man
This is *wrong*. It refers to the name of the repository whose natural name is "git", as most people get it by git clone git://git.kernel.org/pub/scm/git/git.git and telling the users to do git clone git://git.kernel.org/pub/scm/git/git-htmldocs.git git clone git://git.kernel.org/pub/scm/git/git-manpages.git in the same directory as they cloned git.git into (i.e. have these two next to their clone of git.git, which is typically called "git"). I'll revert this part.
quoted hunk
diff --git a/Documentation/git-rm.txt b/Documentation/git-rm.txt index 262436b..1e5ef3b 100644 --- a/Documentation/git-rm.txt +++ b/Documentation/git-rm.txt@@ -74,7 +74,7 @@ DISCUSSION The <file> list given to the command can be exact pathnames, file glob patterns, or leading directory names. The command -removes only the paths that are known to git. Giving the name of +removes only the paths that are known to Git. Giving the name of a file that you have not told git about does not remove that file.
This should be "you have not told Git about".
quoted hunk
diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt index e2301f5..c07ad61 100644 --- a/Documentation/git-filter-branch.txt +++ b/Documentation/git-filter-branch.txt
quoted hunk
@@ -29,7 +29,7 @@ The command will only rewrite the _positive_ refs mentioned in the command line (e.g. if you pass 'a..b', only 'b' will be rewritten). If you specify no filters, the commits will be recommitted without any changes, which would normally have no effect. Nevertheless, this may be -useful in the future for compensating for some git bugs or such, +useful in the future for compensating for some Git bugs or such, therefore such a usage is permitted.
The description before this hunk begins with "Lets you rewrite git version history", which you need s/git/Git/.
quoted hunk
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index 9a914d0..3a62f50 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt@@ -525,8 +525,8 @@ $ git format-patch -M -B origin Additionally, it detects and handles renames and complete rewrites intelligently to produce a renaming patch. A renaming patch reduces the amount of text output, and generally makes it easier to review. -Note that non-git "patch" programs won't understand renaming patches, so -use it only when you know the recipient uses git to apply your patch. +Note that non-Git "patch" programs won't understand renaming patches, so +use it only when you know the recipient uses Git to apply your patch.
Unrelated to the topic of this series, but didn't GNU patch add this recently? Somebody needs a fact-check and may have to update the above with something like "prior to GNU patch x.y..."
quoted hunk
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index 9e0b3f6..071e947 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt@@ -14,7 +14,7 @@ DESCRIPTION ----------- With no options and no COMMAND given, the synopsis of the 'git' -command and a list of the most commonly used git commands are printed +command and a list of the most commonly used Git commands are printed on the standard output. If the option '--all' or '-a' is given, then all available commands are
After this hunk there is If a git command is named, a manual page for that... It is trying to refer to things like "cat-file" as "git command" (even though technically I would call them "subcommands"), and I would say "cat-file" is a subcommand of the system whose whole is known as "Git". So I think s/git/Git/ is warranted here.
quoted hunk
diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt index 9ac2bba..2571f56 100644 --- a/Documentation/git-init.txt +++ b/Documentation/git-init.txt@@ -58,19 +58,19 @@ DIRECTORY" section below.) --separate-git-dir=<git dir>:: Instead of initializing the repository where it is supposed to be, -place a filesytem-agnostic git symbolic link there, pointing to the -specified git path, and initialize a git repository at the path. The -result is git repository can be separated from working tree. If this +place a filesytem-agnostic Git symbolic link there, pointing to the +specified Git path, and initialize a Git repository at the path. The +result is Git repository can be separated from working tree. If this
Not a problem with this conversion, but I think "pointing to the specified [gG]it path" should be without "[gG]it". There is nothing specially Git about the path to the directory the user specifies. It is just an ordinary filesystem path. I'll try to fix all of the above up locally and re-queue, so please eyeball the results once it is pushed out.