From: Jonathan Nieder <jrnieder@gmail.com>
To: Thomas Ackermann <th.acker@arcor.de>
Cc: git@vger.kernel.org, gitster@pobox.com, wking@tremily.us
Subject: Re: [PATCH 05/13] Fix some typos
Date: Sat, 24 Aug 2013 22:01:59 -0700 [thread overview]
Message-ID: <20130825050159.GH2882@elie.Belkin> (raw)
In-Reply-To: <1171853844.1090991.1377329328622.JavaMail.ngmail@webmail08.arcor-online.net>
Thomas Ackermann wrote:
> --- 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.
[...]
> @@ -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.
> @@ -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.
[...]
> @@ -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.
[...]
> @@ -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
next prev parent reply other threads:[~2013-08-25 5:05 UTC|newest]
Thread overview: 44+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-08-24 7:22 [PATCH 0/13] Modernize user-manual Thomas Ackermann
2013-08-24 7:24 ` [PATCH 01/13] Call it "Git User Manual" and remove reference to very old Git version Thomas Ackermann
2013-08-25 3:05 ` Jonathan Nieder
2013-08-25 3:07 ` Junio C Hamano
2013-08-24 7:25 ` [PATCH 02/13] Use current "detached HEAD" message Thomas Ackermann
2013-08-25 3:49 ` Jonathan Nieder
2013-08-25 8:10 ` Aw: " Thomas Ackermann
2013-08-24 7:26 ` [PATCH 03/13] Use current output for "git repack" Thomas Ackermann
2013-08-25 4:15 ` Jonathan Nieder
2013-08-25 8:37 ` Aw: " Thomas Ackermann
2013-08-24 7:27 ` [PATCH 04/13] Use "git merge" instead of "git pull ." Thomas Ackermann
2013-08-25 3:17 ` Junio C Hamano
2013-08-25 4:19 ` Jonathan Nieder
2013-08-25 5:26 ` Martin von Zweigbergk
2013-08-24 7:28 ` [PATCH 05/13] Fix some typos Thomas Ackermann
2013-08-25 5:01 ` Jonathan Nieder [this message]
2013-08-25 9:13 ` Aw: " Thomas Ackermann
2013-08-24 7:29 ` [PATCH 06/13] Simplify "How to make a commit" Thomas Ackermann
2013-08-25 3:20 ` Junio C Hamano
2013-08-25 5:05 ` Jonathan Nieder
2013-08-25 9:20 ` Aw: " Thomas Ackermann
2013-08-24 7:30 ` [PATCH 07/13] Improve description in "How to merge" Thomas Ackermann
2013-08-25 3:22 ` Junio C Hamano
2013-08-25 5:08 ` Jonathan Nieder
2013-08-25 11:31 ` Aw: " Thomas Ackermann
2013-08-24 7:31 ` [PATCH 08/13] Improve section "Manipulating branches" Thomas Ackermann
2013-08-25 3:25 ` Junio C Hamano
2013-08-25 11:41 ` Aw: " Thomas Ackermann
2013-08-24 7:32 ` [PATCH 09/13] Improve section "Merge multiple trees" Thomas Ackermann
2013-08-25 5:23 ` Jonathan Nieder
2013-08-25 12:06 ` Aw: " Thomas Ackermann
2013-08-25 20:10 ` Jonathan Nieder
2013-08-24 7:33 ` [PATCH 10/13] Remove unnecessary historical note from "Object storage format" Thomas Ackermann
2013-08-25 3:28 ` Junio C Hamano
2013-08-24 7:34 ` [PATCH 11/13] Remove obscure reference from "Examples" Thomas Ackermann
2013-08-25 3:53 ` Junio C Hamano
2013-08-25 5:25 ` Jonathan Nieder
2013-08-25 9:30 ` Aw: " Thomas Ackermann
2013-08-24 7:35 ` [PATCH 12/13] Remove irrelevant reference from "Tying it all together" Thomas Ackermann
2013-08-25 3:56 ` Junio C Hamano
2013-08-26 13:51 ` Jon Loeliger
2013-08-24 7:37 ` [PATCH 13/13] "git prune" is safe now Thomas Ackermann
2013-08-25 3:59 ` Junio C Hamano
2013-08-24 19:31 ` [PATCH 0/13] Modernize user-manual Philip Oakley
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20130825050159.GH2882@elie.Belkin \
--to=jrnieder@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=th.acker@arcor.de \
--cc=wking@tremily.us \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).