git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
TATor Arntsen <tor@spacetec.no>
Date
Sep 4, 2011, 20:43 UTC
Message-ID
<4E63E2FF.2070603@spacetec.no>
In-Reply-To
<f415402994735a60664e1f9f85be490a68b25ed3.1315167848.git.trast@student.ethz.ch>
On 04/09/2011 22:28, Thomas Rast wrote:
Show 36 quoted lines
> 
> Users had problems finding a working setting for notes.rewriteRef.
> Document how to enable rewriting for all notes.
> 
> Signed-off-by: Thomas Rast <trast@student.ethz.ch>
> ---
> [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
Previous: Thomas RastNext: Jeff King
Message 15 of 20 in “Lost association between TAGS and COMMITs when rebased a git(1) repository”
  1. John S. UrbanSep 4, 2011
  2. PJ WeisbergSep 4, 2011
  3. Michael WittenSep 4, 2011
  4. Michael WittenSep 4, 2011
  5. Philip OakleySep 4, 2011
  6. knittlSep 4, 2011
  7. knittlSep 4, 2011
  8. Michael WittenSep 4, 2011
  9. Jakub NarebskiSep 4, 2011
  10. Tor ArntsenSep 4, 2011
  11. Thomas RastSep 4, 2011
  12. Tor ArntsenSep 4, 2011
  13. John S. UrbanSep 4, 2011
  14. Documentation: "on for all" configuration of notes.rewriteRefThomas Rast, Sep 4, 2011
  15. Tor ArntsenSep 4, 2011
  16. Jeff KingSep 7, 2011
  17. Thomas RastSep 7, 2011
  18. Jeff KingSep 7, 2011
  19. Michael WittenSep 4, 2011
  20. John S. UrbanSep 4, 2011

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.