Re: [PATCH 05/13] Fix some typos

From: Jonathan Nieder <jrnieder@gmail.com>
Date: Aug 25, 2013, 05:01 UTC
Message-ID: <20130825050159.GH2882@elie.Belkin>
In-Reply-To: <1171853844.1090991.1377329328622.JavaMail.ngmail@webmail08.arcor-online.net>

Thomas Ackermann wrote:

Show 8 quoted lines

> --- a/Documentation/user-manual.txt
> +++ b/Documentation/user-manual.txt
> @@ -219,7 +219,7 @@ of development leading to that point.
>  
>  The best way to see how this works is using the linkgit:gitk[1]
>  command; running gitk now on a Git repository and looking for merge
> -commits will help understand how the Git organizes history.
> +commits will help understand how Git organizes history.

Heh.  Sure.

[...]

Show 7 quoted lines

> @@ -793,7 +793,7 @@ e05db0fd4f31dde7005f075a84f96b360d05984b
>  -------------------------------------------------
>  
>  Or you could recall that the `...` operator selects all commits
> -contained reachable from either one reference or the other but not
> +reachable from either one reference or the other but not
>  both; so

Yes. Here one of the references is the nickname of a remote and not a branch, so "reachable from" reads better than "contained in" would.

Show 6 quoted lines

> @@ -820,7 +820,7 @@ You could just visually inspect the commits since e05db0fd:
>  $ gitk e05db0fd..
>  -------------------------------------------------
>  
> -Or you can use linkgit:git-name-rev[1], which will give the commit a
> +or you can use linkgit:git-name-rev[1], which will give the commit a

I think this reads better with a capital 'O'. (The pedant in me likes it, too, since a colon ends a sentence.)

The lowercase 'but' later in this section should perhaps also be capitalized, since it also starts an independent thought.

	But that may sometimes help you guess which tags come after the
	given commit.

The sentence "So, you can run something like ... then search for a line that looks like ..." is a sequence of incomplete thoughts. It could be paraphrased a little to scan better:

	So, if you run something like "git show-branch e05db0fd
	v1.5.0-rc0 v1.5.0-rc1 v1.5.0-rc2"

		$ git show-branch e05db0fd v1.5.0-rc0 v1.5.0-rc1 v1.5.0-rc2
		! [e05db...

	then a line like

		+ ++ [e05db0fd] Fix warnings in ...

	shows that e05db0fd is reachable from itself, from v1.5.0-rc1,
	and from v1.5.0-rc2, and not from v1.5.0-rc0.

[...]

Show 6 quoted lines

> @@ -3525,7 +3525,7 @@ with Git 1.5.2 can look up the submodule commits in the repository and
>  manually check them out; earlier versions won't recognize the submodules at
>  all.
>  
> -To see how submodule support works, create (for example) four example
> +To see how submodule support works, create four example

I'd keep the joke.

[...]

Show 7 quoted lines

> @@ -3897,7 +3897,7 @@ fact that such a commit brings together ("merges") two or more
>  previous states represented by other commits.
>  
>  In other words, while a "tree" represents a particular directory state
> -of a working directory, a "commit" represents that state in "time",
> +of a working directory, a "commit" represents that state in time,
>  and explains how we got there.

It's not really about time but about (hypothetical, possibly branched) history, but I think your change makes it about as clear as it can be.

Thanks, and hope that helps, Jonathan