Re: [PATCH v4 1/4] githooks.txt: Improve the intro section

From: Junio C Hamano <gitster@pobox.com>
Date: Apr 26, 2016, 19:48 UTC
Message-ID: <xmqqr3dsf8xg.fsf@gitster.mtv.corp.google.com>
In-Reply-To: <1461694402-9629-2-git-send-email-avarab@gmail.com>

Ævar Arnfjörð Bjarmason  <avarab@gmail.com> writes:

>  * We note what happens with chdir() before a hook is called, nothing
>    documented this explicitly, but the current behavior is
>    predictable. It helps a lot to know what directory these hooks will
>    be executed from.

I _think_ this item is what you meant by "changed the wording for all of this to hopefully be more clear in my v4.", but I do not think it addresses "find it somehow and then chdir()" confusion.

It does say "it is run at", meaning that chdir() happens before it is run. That is not sufficient to let the reader guess taht chdir() happens before the hooks directory is checked relative to that directory to find the hook to run.

> +When 'git init' is run it may, depending on its configuration, copy
> +hooks to the new repository, see the the "TEMPLATE DIRECTORY" section

"... is run, it may, depending on its configuration, copy hooks..."

If that is too much sentence fragments, you could reorder them, e.g.

	'git init' may copy hooks to the new repository, depending
	on its configuration.  See the "TEMPLATE DIRECTORY" section

That would fix "the the" as a side effect ;-).

Show 8 quoted lines

> +in linkgit:git-init[1] for details. When the rest of this document
> +refers to "default hooks" it's talking about the default template
> +shipped with Git.
> +
> +The currently supported hooks are described below.
>  
>  HOOKS
>  -----