Subject: Re: [PATCH] Documentation: "on for all" configuration of notes.rewriteRef

From: "Tor Arntsen" <[email-masked]>
Date: Sun, 04 Sep 2011 22:43:43 +0200

On 04/09/2011 22:28, Thomas Rast wrote:
> 
> Users had problems finding a working setting for notes.rewriteRef.
> Document how to enable rewriting for all notes.
> 
> Signed-off-by: Thomas Rast <[email-masked]>
> ---
> [Sorry for the spam; the first one lacks my reply blurb and the
> in-reply-to. :-( ]
> 
> Tor Arntsen wrote:
>> Thanks. Got it working. So it's not by default, as was suggested by
>> knittl, it has to be enabled. BTW, it's not at all obvious from the
>> manpage what it should be set to, there's no actual example. Found it
>> by trial&error plus finding a diff for a test.
> 
> Let's document it then.  This still won't help you find out about the
> option/feature in the first place, though.  Maybe we should flip the
> default to enabled?
> 
>  Documentation/config.txt |    3 ++-
>  1 files changed, 2 insertions(+), 1 deletions(-)
> 
> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index 0ecef9d..302b2d0 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/*` to enable rewriting
> +for all notes.
>  +
>  This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
>  environment variable, which must be a colon separated list of refs or

Looks good to me, it would have been sufficient for me to find it 
right away. But, as you say, it requires you to know or be told about 
the feature in the first place.. 
As far as I'm concerned it would be perfect if it was set to refs/notes/*
by default, but people are using notes for all kinds of things. Maybe there
are issues with using that default that I don't know about.

-Tor