Documentation: basic configuration of notes.rewriteRef

trast · gitster · commit 2b4aa89c27a5 · 2011-09-13T08:35:38.000-07:00
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 &lt;trast@student.ethz.ch&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git 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

Original file line number	Diff line number	Diff line change
`@@ -1445,7 +1445,8 @@ notes.rewriteRef::`
`1445`	`1445`	`You may also specify this configuration several times.`
`1446`	`1446`	`+`
`1447`	`1447`	`Does not have a default value; you must configure this variable to`
`1448`		`-enable note rewriting.`
	`1448`	+enable note rewriting. Set it to `refs/notes/commits` to enable
	`1449`	`+rewriting for the default commit notes.`
`1449`	`1450`	`+`
`1450`	`1451`	This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
`1451`	`1452`	`environment variable, which must be a colon separated list of refs or`