Re: Documentation of post-receive hook

From: Junio C Hamano <gitster@pobox.com>
Date: Nov 22, 2017, 01:14 UTC
Message-ID: <xmqqlgizyv0o.fsf@gitster.mtv.corp.google.com>
In-Reply-To: <A82275FD-C9AC-4632-A5E8-ED86CE2AC67D@gmail.com>

Christoph Michelbach <michelbach94@gmail.com> writes:

Show 11 quoted lines

> On November 20, 2017 2:17:58 AM GMT+01:00, 
>>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.
>
> I think it's much more intelligible but a hint as to when this
> happens wouldn't hurt. E.g.: "This does not happen if the user
> receives the message 'Already up-to-date'." That is if this is
> correct, of course.

Your suggesting to mention that particular message hints at me that you feel that the users may not necessarily understand that push did not result in any update of references on the other side when they see it. If the message was clear enough to them, "when it reacts to push and updates" ought to be clear enough description, too.

And if that indeed is the case (and I would not be surprised if it is, but I suspect that most users are clueful enough), it is not the documentation, but the "Already up-to-date" message, that needs to be clarified, no?

Besides, we'd rather not cast the end-user facing message in stone in the documentation like that (especially when the message has known room for improvement and will change).