Code

core-tutorial.txt: Fix showing the current behaviour.
authorCarlos Rica <jasampler@gmail.com>
Thu, 10 Apr 2008 00:08:23 +0000 (02:08 +0200)
committerJunio C Hamano <gitster@pobox.com>
Thu, 10 Apr 2008 07:20:41 +0000 (00:20 -0700)
The --root option from "git diff-tree" won't do nothing
when is given to commands like git-whatchanged or git-log,
because those always print the initial commit by default.

This fixes the tutorial explaining the function of the
log.showroot configuration variable.

Signed-off-by: Carlos Rica <jasampler@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/core-tutorial.txt

index aa40dfd36a6f210c5808791225014e023d18c0de..5a5531222d8f514b27ba63d9fc9ecc17335cdc3c 100644 (file)
@@ -535,18 +535,18 @@ with the associated patches use the more complex (and much more
 powerful)
 
 ----------------
-$ git-whatchanged -p --root
+$ git-whatchanged -p
 ----------------
 
 and you will see exactly what has changed in the repository over its
 short history.
 
 [NOTE]
-The `\--root` flag is a flag to `git-diff-tree` to tell it to
-show the initial aka 'root' commit too. Normally you'd probably not
-want to see the initial import diff, but since the tutorial project
-was started from scratch and is so small, we use it to make the result
-a bit more interesting.
+When using the above two commands, the initial commit will be shown.
+If this is a problem because it is huge, you can hide it by setting
+the log.showroot configuration variable to false. Having this, you
+can still show it for each command just adding the `\--root` option,
+which is a flag for `git-diff-tree` accepted by both commands.
 
 With that, you should now be having some inkling of what git does, and
 can explore on your own.