Re: Documentation of post-receive hook

From: Junio C Hamano <gitster@pobox.com>
Date: Nov 20, 2017, 01:17 UTC
Message-ID: <xmqq1sktoiih.fsf@gitster.mtv.corp.google.com>
In-Reply-To: <1511112703.8109.5.camel@gmail.com>

Christoph Michelbach <michelbach94@gmail.com> writes:

Show 11 quoted lines

> On Fri, 2017-11-17 at 12:24 +0900, Junio C Hamano wrote:
>> So an updated suggestion for the text would be:
>> 
>>      This hook is invoked by 'git-receive-pack' on the remote repository,
>>      which happens when a 'git push' is done on a local repository.
>> 
>> Oh, wait.  That is what we already have ;-).
>
> But this text suggests that the hook is always invoked when a git push to that
> repo is done, which is not the case. How about adding "and updates are reference
> in the remote repository"?

Yeah, I think we are moving in the right direction. Let's step back a bit and try not to say "remote repository" twice.

For that matter, I am not sure if local/remote is adding much value, to be honest. It has a certain value to clarify that the receive is happening on the other end of the push (i.e. not in the repository you push from), but we do not have to use local/remote for that--- and it is better to avoid 'local', that is relative: if you are in the mindset of thinking about what happens during a receive, the repository the receive-pack and the hook operates in is 'local' and not 'remote' (it is only 'remote' if you think you are the one who is pushing).

How about this rewrite? Would it consider all the points raised and make it easier to understand?

    This hook is invoked by 'git-receive-pack' when it reacts to
    'git push' and updates reference(s) in its repository.