Fix git-rerere documentation
authorJunio C Hamano <gitster@pobox.com>
Mon, 14 Jan 2008 23:10:38 +0000 (15:10 -0800)
committerJunio C Hamano <gitster@pobox.com>
Tue, 15 Jan 2008 00:14:29 +0000 (16:14 -0800)
rerere.enabled is _not_ on by default.  The command is enabled if rr-cache
exists even when rerere.enabled is missing, and enabled or disabled by
explicitly setting the rerere.enabled variable.

Documentation/config.txt
Documentation/git-rerere.txt
Makefile

index df091d1b8a6ae5fa340171d1a58854d41b6246d7..877eda960d5964b4c036433899977cf47f17846b 100644 (file)
@@ -543,8 +543,8 @@ rerere.enabled::
        Activate recording of resolved conflicts, so that identical
        conflict hunks can be resolved automatically, should they
        be encountered again.  linkgit:git-rerere[1] command is by
-       default enabled, but can be disabled by setting this option to
-       false.
+       default enabled if you create `rr-cache` directory under
+       `$GIT_DIR`, but can be disabled by setting this option to false.
 
 gitcvs.enabled::
        Whether the CVS server interface is enabled for this repository.
index 3793267dadfa52a30cb59ad75170f5f9e9b8e81f..a53858e2503f52b68739264f026c6532ba733d1f 100644 (file)
@@ -22,6 +22,10 @@ automerge results and corresponding hand-resolve results on the
 initial manual merge, and later by noticing the same automerge
 results and applying the previously recorded hand resolution.
 
+[NOTE]
+You need to set the configuration variable rerere.enabled to
+enable this command.
+
 
 COMMANDS
 --------
index 21c80e6bf73163b9770cba5331cd48172fa6d43e..82e9cd626702fe1a1ac983ebbf13969b65017ff1 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1187,3 +1187,4 @@ check-docs::
 #
 check-builtins::
        ./check-builtins.sh
+