Re: [PATCH] Documentation: rerere.enabled overrides [ -d rr-cache ]
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Jan 7, 2012, 05:17 UTC
- Message-ID
- <7vk454gkh3.fsf@alter.siamese.dyndns.org>
- In-Reply-To
- <87boqge19s.fsf@thomas.inf.ethz.ch>
Thomas Rast <trast@student.ethz.ch> writes:
Show 8 quoted lines
> Junio C Hamano <gitster@pobox.com> writes: > >> The manual page for "rerere" talks about "configuration variable >> rerere.enabled"; perhaps it should also refer to git config manual page to >> make it more discoverable? > > Maybe, but it already says you should set the variable in two different > places.
That is not the point.
The documentation for git config seems to be the only place where we explain that the existence of rr-cache determines what happens when the user does _not_ set the variable; lack of that description will lead to the confusion you describe below:
Show 16 quoted lines
>> Thomas Rast <trast@student.ethz.ch> writes: >> >>> ... OTOH the >>> auto-creation of rr-cache can cause strange behavior if a user has >>> rerere.enabled unset and tries it once, as in >>> >>> git config rerere.enabled true >>> git merge ... >>> git config --unset rerere.enabled >> >> That is because the last one should be >> >> git config --bool rerere.enabled false > > I definitely meant --unset. If the user knows the distinction, and > wants to return the variable to the state it had before his test ...
Running "unset" is how to return the _variable_ to the previous state, but that is _not_ how to return to the previous state of the _repository_.
Perhaps something like this in addition?
diff --git a/Documentation/config.txt b/Documentation/config.txt index 04f5e19..c523c67 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -1786,7 +1786,8 @@ rerere.enabled:: conflict hunks can be resolved automatically, should they be encountered again. By default, linkgit:git-rerere[1] is enabled if there is an `rr-cache` directory under the - `$GIT_DIR`. + `$GIT_DIR`, e.g. if "rerere" was previously used in the + repository. sendemail.identity:: A configuration identity. When given, causes values in the