git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Thomas Rast <trast@student.ethz.ch>
To: Junio C Hamano <gitster@pobox.com>
Cc: <git@vger.kernel.org>, Jeff King <peff@peff.net>
Subject: [PATCH v2] Documentation: basic configuration of notes.rewriteRef
Date: Tue, 13 Sep 2011 09:32:42 +0200	[thread overview]
Message-ID: <95a35723c2ac7e3accfceec2cdededcd213fb59b.1315899036.git.trast@student.ethz.ch> (raw)
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

  reply	other threads:[~2011-09-13  7:32 UTC|newest]

Thread overview: 36+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-09-12 20:16 What's cooking in git.git (Sep 2011, #04; Mon, 12) Junio C Hamano
2011-09-12 21:48 ` Junio C Hamano
2011-09-12 21:51 ` Junio C Hamano
2011-09-12 23:27   ` Jeff King
2011-09-13  0:09     ` Junio C Hamano
2011-09-13  9:24       ` Nguyen Thai Ngoc Duy
2011-09-12 21:53 ` Junio C Hamano
2011-09-13  7:32   ` Thomas Rast [this message]
2011-09-13 17:16     ` [PATCH v2] Documentation: basic configuration of notes.rewriteRef Junio C Hamano
2011-09-13 17:18     ` Jeff King
2011-09-12 21:55 ` What's cooking in git.git (Sep 2011, #04; Mon, 12) Junio C Hamano
2011-09-12 21:59 ` Junio C Hamano
2011-09-14  2:34   ` Jonathon Mah
2011-09-14 20:57     ` Junio C Hamano
2011-09-16  2:12       ` [PATCH] mergetool: Use args as pathspec to unmerged files Jonathon Mah
2011-09-16 20:17         ` Junio C Hamano
2011-09-25  0:45           ` David Aguilar
2011-09-26 16:40             ` Junio C Hamano
2011-09-12 22:02 ` What's cooking in git.git (Sep 2011, #04; Mon, 12) Junio C Hamano
2011-09-12 23:15   ` Sverre Rabbelier
2011-09-12 22:56 ` Junio C Hamano
2011-09-13  9:46   ` Erik Faye-Lund
2011-09-29 12:03     ` Pascal Obry
2011-09-12 22:58 ` Junio C Hamano
2011-09-13 12:05   ` Michael J Gruber
     [not found] ` <7vk49d5t8u.fsf@alter.siamese.dyndns.org>
2011-09-12 23:15   ` Eric Sunshine
2011-09-12 23:25     ` Junio C Hamano
2011-09-12 23:33       ` Jeff King
2011-09-12 23:53         ` Jeff King
2011-09-13 15:15         ` Brandon Casey
2011-09-13 16:05           ` Jeff King
2011-09-13 16:22             ` Brandon Casey
2011-09-13  7:51     ` John Szakmeister
2011-09-13 15:04       ` Eric Sunshine
2011-09-13 17:20         ` Jeff King
2011-09-12 23:35   ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=95a35723c2ac7e3accfceec2cdededcd213fb59b.1315899036.git.trast@student.ethz.ch \
    --to=trast@student.ethz.ch \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=peff@peff.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).