undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix trivial typos and inconsistencies in hooks documentation

Browse Source 
Pointed out by Alan Chandler.

Signed-off-by: Jonas Fonseca <fonseca@diku.dk>
Signed-off-by: Junio C Hamano <junkio@cox.net>
This commit is contained in:
Jonas Fonseca 2006-09-20 12:15:39 +02:00 committed by Junio C Hamano
parent 8059319acc
commit 45ad9b5096
1 changed files with 28 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
Documentation/hooks.txt
View File

@ -5,8 +5,7 @@ Hooks are little scripts you can place in `$GIT_DIR/hooks`
directory to trigger action at certain points. When directory to trigger action at certain points. When
`git-init-db` is run, a handful example hooks are copied in the `git-init-db` is run, a handful example hooks are copied in the
`hooks` directory of the new repository, but by default they are `hooks` directory of the new repository, but by default they are
all disabled. To enable a hook, make it executable with `chmod all disabled. To enable a hook, make it executable with `chmod +x`.
+x`.
This document describes the currently defined hooks. This document describes the currently defined hooks.
@ -16,16 +15,16 @@ applypatch-msg
This hook is invoked by `git-applypatch` script, which is This hook is invoked by `git-applypatch` script, which is
typically invoked by `git-applymbox`. It takes a single typically invoked by `git-applymbox`. It takes a single
parameter, the name of the file that holds the proposed commit parameter, the name of the file that holds the proposed commit
log message. Exiting with non-zero status causes the log message. Exiting with non-zero status causes
'git-applypatch' to abort before applying the patch. `git-applypatch` to abort before applying the patch.
The hook is allowed to edit the message file in place, and can The hook is allowed to edit the message file in place, and can
be used to normalize the message into some project standard be used to normalize the message into some project standard
format (if the project has one). It can also be used to refuse format (if the project has one). It can also be used to refuse
the commit after inspecting the message file. the commit after inspecting the message file.
The default applypatch-msg hook, when enabled, runs the The default 'applypatch-msg' hook, when enabled, runs the
commit-msg hook, if the latter is enabled. 'commit-msg' hook, if the latter is enabled.
pre-applypatch pre-applypatch
-------------- --------------
@ -39,8 +38,8 @@ after application of the patch not committed.
It can be used to inspect the current working tree and refuse to It can be used to inspect the current working tree and refuse to
make a commit if it does not pass certain test. make a commit if it does not pass certain test.
The default pre-applypatch hook, when enabled, runs the The default 'pre-applypatch' hook, when enabled, runs the
pre-commit hook, if the latter is enabled. 'pre-commit' hook, if the latter is enabled.
post-applypatch post-applypatch
--------------- ---------------
@ -61,9 +60,9 @@ invoked before obtaining the proposed commit log message and
making a commit. Exiting with non-zero status from this script making a commit. Exiting with non-zero status from this script
causes the `git-commit` to abort. causes the `git-commit` to abort.
The default pre-commit hook, when enabled, catches introduction The default 'pre-commit' hook, when enabled, catches introduction
of lines with trailing whitespaces and aborts the commit when of lines with trailing whitespaces and aborts the commit when
a such line is found. such a line is found.
commit-msg commit-msg
---------- ----------
@ -79,8 +78,8 @@ be used to normalize the message into some project standard
format (if the project has one). It can also be used to refuse format (if the project has one). It can also be used to refuse
the commit after inspecting the message file. the commit after inspecting the message file.
The default commit-msg hook, when enabled, detects duplicate The default 'commit-msg' hook, when enabled, detects duplicate
Signed-off-by: lines, and aborts the commit when one is found. "Signed-off-by" lines, and aborts the commit if one is found.
post-commit post-commit
----------- -----------
@ -91,20 +90,21 @@ parameter, and is invoked after a commit is made.
This hook is meant primarily for notification, and cannot affect This hook is meant primarily for notification, and cannot affect
the outcome of `git-commit`. the outcome of `git-commit`.
The default post-commit hook, when enabled, demonstrates how to The default 'post-commit' hook, when enabled, demonstrates how to
send out a commit notification e-mail. send out a commit notification e-mail.
update update
------ ------
This hook is invoked by `git-receive-pack` on the remote repository, This hook is invoked by `git-receive-pack` on the remote repository,
which is happens when a `git push` is done on a local repository. which happens when a `git push` is done on a local repository.
Just before updating the ref on the remote repository, the update hook Just before updating the ref on the remote repository, the update hook
is invoked. Its exit status determines the success or failure of is invoked. Its exit status determines the success or failure of
the ref update. the ref update.
The hook executes once for each ref to be updated, and takes The hook executes once for each ref to be updated, and takes
three parameters: three parameters:
- the name of the ref being updated, - the name of the ref being updated,
- the old object name stored in the ref, - the old object name stored in the ref,
- and the new objectname to be stored in the ref. - and the new objectname to be stored in the ref.
@ -126,16 +126,16 @@ Another use suggested on the mailing list is to use this hook to
implement access control which is finer grained than the one implement access control which is finer grained than the one
based on filesystem group. based on filesystem group.
The standard output of this hook is sent to /dev/null; if you The standard output of this hook is sent to `/dev/null`; if you
want to report something to the git-send-pack on the other end, want to report something to the `git-send-pack` on the other end,
you can redirect your output to your stderr. you can redirect your output to your `stderr`.
post-update post-update
----------- -----------
This hook is invoked by `git-receive-pack` on the remote repository, This hook is invoked by `git-receive-pack` on the remote repository,
which is happens when a `git push` is done on a local repository. which happens when a `git push` is done on a local repository.
It executes on the remote repository once after all the refs have It executes on the remote repository once after all the refs have
been updated. been updated.
@ -145,16 +145,16 @@ name of ref that was actually updated.
This hook is meant primarily for notification, and cannot affect This hook is meant primarily for notification, and cannot affect
the outcome of `git-receive-pack`. the outcome of `git-receive-pack`.
The post-update hook can tell what are the heads that were pushed, The 'post-update' hook can tell what are the heads that were pushed,
but it does not know what their original and updated values are, but it does not know what their original and updated values are,
so it is a poor place to do log old..new. so it is a poor place to do log old..new.
The default post-update hook, when enabled, runs When enabled, the default 'post-update' hook runs
`git-update-server-info` to keep the information used by dumb `git-update-server-info` to keep the information used by dumb
transports (e.g., http) up-to-date. If you are publishing transports (e.g., HTTP) up-to-date. If you are publishing
a git repository that is accessible via http, you should a git repository that is accessible via HTTP, you should
probably enable this hook. probably enable this hook.
The standard output of this hook is sent to /dev/null; if you The standard output of this hook is sent to `/dev/null`; if you
want to report something to the git-send-pack on the other end, want to report something to the `git-send-pack` on the other end,
you can redirect your output to your stderr. you can redirect your output to your `stderr`.