summaryrefslogtreecommitdiff
path: root/Documentation/config.txt
diff options
context:
space:
mode:
authorLibravatar Thomas Rast <trast@student.ethz.ch>2011-09-13 09:32:42 +0200
committerLibravatar Junio C Hamano <gitster@pobox.com>2011-09-13 08:35:38 -0700
commit2b4aa89c27a5b7db37bfa992ec8500cc9f4b31a5 (patch)
treee2354aca0401d20dc7747acecff4288b31714211 /Documentation/config.txt
parentDocumentation: clarify effects of -- <path> arguments (diff)
downloadtgif-2b4aa89c27a5b7db37bfa992ec8500cc9f4b31a5.tar.xz
Documentation: basic configuration of notes.rewriteRef
Users had problems finding a working setting for notes.rewriteRef. Document how to enable rewriting for notes/commits, which should be a safe setting. Signed-off-by: Thomas Rast <trast@student.ethz.ch> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/config.txt')
-rw-r--r--Documentation/config.txt3
1 files changed, 2 insertions, 1 deletions
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 4914d768c7..cc39f8639a 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -1445,7 +1445,8 @@ notes.rewriteRef::
You may also specify this configuration several times.
+
Does not have a default value; you must configure this variable to
-enable note rewriting.
+enable note rewriting. Set it to `refs/notes/commits` to enable
+rewriting for the default commit notes.
+
This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
environment variable, which must be a colon separated list of refs or