Re: [PATCH] contrib/hooks: adapt default Debian install location for contrib hooks

From: Junio C Hamano <gitster@pobox.com>
Date: Sep 20, 2011, 19:44 UTC
Message-ID: <7vr53b578t.fsf@alter.siamese.dyndns.org>
In-Reply-To: <20110920111914.17913.qmail@d29ca435be5a3d.315fe32.mid.smarden.org>

Gerrit Pape <pape@smarden.org> writes:

Show 15 quoted lines

> diff --git a/contrib/hooks/post-receive-email b/contrib/hooks/post-receive-email
> index fa6d41a..ba077c1 100755
> --- a/contrib/hooks/post-receive-email
> +++ b/contrib/hooks/post-receive-email
> @@ -11,11 +11,11 @@
>  # will have put this somewhere standard.  You should make this script
>  # executable then link to it in the repository you would like to use it in.
>  # For example, on debian the hook is stored in
> -# /usr/share/doc/git-core/contrib/hooks/post-receive-email:
> +# /usr/share/git-core/contrib/hooks/post-receive-email:
>  #
>  #  chmod a+x post-receive-email
>  #  cd /path/to/your/repository.git
> -#  ln -sf /usr/share/doc/git-core/contrib/hooks/post-receive-email hooks/post-receive
> +#  ln -sf /usr/share/git-core/contrib/hooks/post-receive-email hooks/post-receive

This one I do not have any problem with; the leading text makes it very clear that this is an example that is specific to Debian and that is good enough to signal readers that they may have to look elsewhere if they are on a different distribution.

Show 10 quoted lines

> diff --git a/templates/hooks--post-receive.sample b/templates/hooks--post-receive.sample
> index 7a83e17..e48346e 100755
> --- a/templates/hooks--post-receive.sample
> +++ b/templates/hooks--post-receive.sample
> @@ -12,4 +12,4 @@
>  # see contrib/hooks/ for a sample, or uncomment the next line and
>  # rename the file to "post-receive".
>  
> -#. /usr/share/doc/git-core/contrib/hooks/post-receive-email
> +#. /usr/share/git-core/contrib/hooks/post-receive-email

I am however not sure about this. For one thing, it is not clear that this (both old and new) text are meant to be Debian specific, and they should not complain and instead should look for it elsewhere, if the users do not find the sample in the path that is shown in the file. For another, it is not "see ... for a sample, OR UNCOMMENT" at all, for readers who are _NOT_ interested in sending e-mails from the hook at all, but the way it is stated makes it sound as if people who do not want to bother reading the samples can blindly enable the hook and it is guaranteed that the particular sample hook satisfies their needs, which is not the case.

Perhaps removing this sample file might be a better option. The first ten lines or so repeat what the documentation says, which can go stale, and if we remove them, the only thing that remains is the "see contrib/hooks for a sample".

Thanks.