[PATCH v2] Documentation: basic configuration of notes.rewriteRef

From: Thomas Rast <trast@student.ethz.ch>
Date: Sep 13, 2011, 07:32 UTC
Message-ID: <95a35723c2ac7e3accfceec2cdededcd213fb59b.1315899036.git.trast@student.ethz.ch>
In-Reply-To: <7vzki92wdc.fsf@alter.siamese.dyndns.org>

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>
---

Junio C Hamano wrote:

> Should we drop this post 1.7.7, or (preferrably) replace it with better
> instructions?

I'd replace it with this bit. Users who have trouble setting the variable to something useful will likely not know how to edit non-default notes trees, either.

 Documentation/config.txt |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 0ecef9d..0813812 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -1464,7 +1464,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

-- 
1.7.7.rc0.487.g1b75