]> git.ipfire.org Git - thirdparty/git.git/commit - Documentation/githooks.txt
githooks.txt: improve the intro section
authorÆvar Arnfjörð Bjarmason <avarab@gmail.com>
Wed, 4 May 2016 22:58:09 +0000 (22:58 +0000)
committerJunio C Hamano <gitster@pobox.com>
Wed, 4 May 2016 23:22:23 +0000 (16:22 -0700)
commit49fa52fd003ece5ea997607167bc5aaec3ff61af
tree1f9545b1a46c96ee807c53968f33f1fcf41600d4
parent90f7b16b3adc78d4bbabbd426fb69aa78c714f71
githooks.txt: improve the intro section

Change the documentation so that:

 * We don't talk about "little scripts". Hooks can be as big as you
   want, and don't have to be scripts, just call them "programs".

 * We note that we change the working directory 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.

 * We don't make claims about the example hooks which may not be true
   depending on the configuration of 'init.templateDir'. Clarify that
   we're talking about the default settings of git-init in those cases,
   and move some of this documentation into git-init's documentation
   about the default templates.

 * We briefly note in the intro that hooks can get their arguments in
   various different ways, and that how exactly is described below for
   each hook.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-init.txt
Documentation/githooks.txt