Documentation: complicate example of "man git-command"
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>
Jonathan Nieder committed
Jun 30, 2008 at 17:10 UTC
3861cd5582d4ae4b41a3bf4c464e780d1725ad4e
2 files changed
+3
-3
Documentation/gittutorial.txt
+2
-2
@@ -20,10 +20,10 @@ for example, to test the latest version, you may prefer to start with
20
the first two chapters of link:user-manual.html[The Git User's Manual].
21
22
First, note that you can get documentation for a command such as "git
23
-diff" with:
23
+log --graph" with:
24
25
------------------------------------------------
26
-$ man git-diff
26
+$ man git-log
27
------------------------------------------------
28
29
It is a good idea to introduce yourself to git with your name and
Documentation/user-manual.txt
+1
-1
@@ -18,7 +18,7 @@ People needing to do actual development will also want to read
18
Further chapters cover more specialized topics.
19
20
Comprehensive reference documentation is available through the man
21
-pages. For a command such as "git clone", just use
21
+pages. For a command such as "git clone <repo>", just use
22
23
------------------------------------------------
24
$ man git-clone