From: Chris Packham <judge.packham@gmail.com>
Date: Tue, 29 Jun 2010 18:16:41 GMT
Subject: Re: [PATCH/RFC] Documentation/git-gc.txt: add reference to githooks
Message-ID: <4C2A3889.90407@gmail.com>
In-Reply-To: <7vfx05by9t.fsf@alter.siamese.dyndns.org>

On 29/06/10 09:26, Junio C Hamano wrote:
> Chris Packham <judge.packham@gmail.com> writes:
>   
>> +HOOKS
>> +-----
>> +This command can run `pre-auto-gc` hook.  See linkgit:githooks[5] for more
>> +information.
>>     
> Hmm.  "git gc --auto" does, but "git gc" doesn't, and saying "can run"
> only adds to the sense of incompleteness of the description here without
> giving useful information to the reader (iow, the user will have to check
> the referred-to page anyway).  We would need to either remove the first
> sentence (leaving only "See ... for information") or clarify the first
> sentence a bit better, I think.
>   
How about

The `git gc --auto` command will run the `pre-auto-gc` hook, if
enabled.  See linkgit:githooks[5] for more information.