hgbook-git: Clarify a point about "git help" that I didn't know.

[cworth.org] / src / hgbook-git / tour.mdwn

diff --git a/src/hgbook-git/tour.mdwn b/src/hgbook-git/tour.mdwn
index a90efd8ffc6b7870daeb01b0eabccc41ec147d90..a8a891ad8e2021284e21115b7fbe83573246c96a 100644 (file)
--- a/src/hgbook-git/tour.mdwn
+++ b/src/hgbook-git/tour.mdwn
@@ -1,4 +1,4 @@
-[[meta title="A tour of git: the basics"]]
+[[!meta title="A tour of git: the basics"]]
 A tour of git: the basics
 
 ### 2.0 Copyright
@@ -120,9 +120,9 @@ times when you find yourself stuck trying to remember how to run a
 command. If you are completely stuck, simply run “git help”; it will
 print a brief list of commonly-used commands, along with a description
 of what each does. If you ask for help on a specific command (such as
-"git help init"), it prints more detailed information. [XXX: Does `git
-help <foo>` work universally as a built-in or does it expect man to be
-present and just call out to `man git-<foo>`?]
+"git help init"), it prints more detailed information. This command
+expects the "man" program to be available and for the git man pages to
+be installed.
 
        [XXX: The original hgbook includes the complete output of "hg
        help init" at this point. I'm not including the corresponding
@@ -132,7 +132,7 @@ present and just call out to `man git-<foo>`?]
        but it only comes after a full screen's worth of options
        details. Might it make sense to have a more summarized help
        output for "git help <foo>" than all of the documentation
-       available for git-<foo>? And perhaps alos provide a "git -v
+       available for git-<foo>? And perhaps also provide a "git -v
        help" similar to "hg -v help" for more?]
 
 ### 2.3 Working with a repository
@@ -234,7 +234,7 @@ discussing how to move commits between repositories:
           $ git clone hello hello-fetch
           $ git clone hello hello-remote
 
-#### 2.3.2 What’s in a repository?
+#### 2.3.3 What’s in a repository?
 
 When we take a more detailed look inside a repository, we can see that
 it contains a directory named .git. This is where git keeps all
@@ -822,6 +822,16 @@ that tell me something that I can’t figure out with a quick glance at
 the output of "git log --stat" or “git log -p", (so repeating the list
 of all modified files is not useful, for example).
 
+To follow along with the example here, go ahead and type something
+like the following sentence into the editor. The misspelling here is
+intentional. You'll see how to fix that up after the fact in just a
+moment:
+
+       Fixed the typo so the program actuall complies now.
+
+Then save the file, and exit from the editor. When you do that, git
+will create the commit.
+
 #### 2.7.4 Aborting a commit
 
 If you decide that you don’t want to commit while in the middle of
@@ -869,13 +879,13 @@ identifier shown above. Can you do it?)
 So now that we've cloned a local repository, made a change to the
 code, setup our name and email address, and made a careful commit,
 we're just about ready to share our change with the world. But wait,
-that commit message has some really embarrassing misspellings in
-it. Wouldn't it be nice to touch those up before I post this commit
+that commit message has that embarrassing misspelling in
+it. Wouldn't it be nice to touch that up before we post this commit
 with a never-to-be-changed again commit identifier?
 
 This is the exact situation for which "git commit --amend" was
-invented. So I can just run that now and fix the broken commit
-message:
+invented. So you can just run that now and fix the broken commit
+message in the editor:
 
        $ git commit --amend
 
@@ -1057,7 +1067,7 @@ Another helpful way of visualizing what happened with "git fetch" here
 is to run "gitk --all", which gives a graphical representation of all
 branches. Here is what it would look like:
 
-[[img gitk-fetch.png]]
+[[!img gitk-fetch.png]]
 
 Notice that origin/master points to a single commit that was committed
 on top of the state pointed to by the "master" branch.