Code

Documentation: complicate example of "man git-command"
authorJonathan Nieder <jrnieder@uchicago.edu>
Mon, 30 Jun 2008 22:10:25 +0000 (17:10 -0500)
committerJunio C Hamano <gitster@pobox.com>
Wed, 2 Jul 2008 00:20:09 +0000 (17:20 -0700)
The manual page for the command invoked as "git clone" is named
git-clone(1), and similarly for the rest of the git commands.
Make sure our first example of this in tutorials makes it clear
that it is the first two words of a command line that make up the
command's name (that is: for example, the effect of "git svn
dcommit" is described in git-svn(1)).

Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/gittutorial.txt
Documentation/user-manual.txt

index 3d16e3d44916ffbe857038d29dca152ecde111b7..b8331672425d7ec9c581294365fc1144029f3806 100644 (file)
@@ -20,10 +20,10 @@ for example, to test the latest version, you may prefer to start with
 the first two chapters of link:user-manual.html[The Git User's Manual].
 
 First, note that you can get documentation for a command such as "git
-diff" with:
+log --graph" with:
 
 ------------------------------------------------
-$ man git-diff
+$ man git-log
 ------------------------------------------------
 
 It is a good idea to introduce yourself to git with your name and
index ca4363ffc016d9b6ebf3c423eba3aceae2f29dfd..36ab37220457d4a992fcbe1fe32023ef75cce23c 100644 (file)
@@ -18,7 +18,7 @@ People needing to do actual development will also want to read
 Further chapters cover more specialized topics.
 
 Comprehensive reference documentation is available through the man
-pages.  For a command such as "git clone", just use
+pages.  For a command such as "git clone <repo>", just use
 
 ------------------------------------------------
 $ man git-clone