Slight in error in git-rerere help page

Slight in error in git-rerere help page

[François Pinard]

Hi, people.  This is for git version 1.6.4.rc3.12.gdf73a

The output of "git help rerere" contains:

   You need to set the configuration variable rerere.enabled to enable
   this command.

It seems that that "enable" is not a proper value.  If I used it over a
small repository, I get:

   22:17:33 0 pinard@phenix:etc $ git config rerere.enabled enable
   22:17:44 0 pinard@phenix:etc $ git gc
   Counting objects: 1072, done.
   Compressing objects: 100% (559/559), done.
   Writing objects: 100% (1072/1072), done.
   Total 1072 (delta 460), reused 1072 (delta 460)
   fatal: bad config value for 'rerere.enabled' in .git/config
   error: failed to run rerere

Removing the rerere section repairs this last problem.

P.S. - I'm also a bit curious about why rerere is needed for a garbage
collection.


-- 
François Pinard   http://pinard.progiciels-bpi.ca

Re: Slight in error in git-rerere help page

[François Pinard]

pinard@iro.umontreal.ca (François Pinard) writes:

> Hi, people.  This is for git version 1.6.4.rc3.12.gdf73a
>
> The output of "git help rerere" contains:
>
>    You need to set the configuration variable rerere.enabled to enable
>    this command.
>
> It seems that that "enable" is not a proper value.  If I used it over a
> small repository, I get:
>
>    22:17:33 0 pinard@phenix:etc $ git config rerere.enabled enable
>    22:17:44 0 pinard@phenix:etc $ git gc
>    Counting objects: 1072, done.
>    Compressing objects: 100% (559/559), done.
>    Writing objects: 100% (1072/1072), done.
>    Total 1072 (delta 460), reused 1072 (delta 460)
>    fatal: bad config value for 'rerere.enabled' in .git/config
>    error: failed to run rerere
>
> Removing the rerere section repairs this last problem.
>
> P.S. - I'm also a bit curious about why rerere is needed for a garbage
> collection.

I now see my mistake, which is one of misreading English.  Sorry for my
noise.  Thanks!

-- 
François Pinard   http://pinard.progiciels-bpi.ca

[PATCH] git-rerere.txt: Clarify ambiguity of the config variable

[Michael J Gruber]

Use the less ambiguous
"set variable foo in order to enable bar"
rather than
"set variable foo to enable bar" which may trick users into
assuming that "enable" is a good value for "foo".

Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
---
I know there is no way to misunderstand this if one looks at the whole
sentence, but still I deem it worthwhile to make it easier on the reader.

Patch is against maint (git-rerere.txt does not have any more recent changes).

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

diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt
index a53c3cd..7dd515b 100644
--- a/Documentation/git-rerere.txt
+++ b/Documentation/git-rerere.txt
@@ -23,7 +23,7 @@ on the initial manual merge, and applying previously recorded
 hand resolutions to their corresponding automerge results.
 
 [NOTE]
-You need to set the configuration variable rerere.enabled to
+You need to set the configuration variable rerere.enabled in order to
 enable this command.
 
 
-- 
1.6.4.rc3.201.gd9d59