doc: improve formatting in githooks.txt
Typeset commands and similar things with as `git foo` instead of 'git foo' or 'git-foo' and add linkgit to the commands which run the hooks. Signed-off-by: Andreas Heiduk <asheiduk@gmail.com> Reviewed-by: Martin Ågren <martin.agren@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>maint
Andreas Heiduk
Junio C Hamano
parent
468165c1d8
commit
9dba84d81c
|
|
@ -31,7 +31,7 @@ Hooks can get their arguments via the environment, command-line
|
|||
arguments, and stdin. See the documentation for each hook below for
|
||||
details.
|
||||
|
||||
'git init' may copy hooks to the new repository, depending on its
|
||||
`git init` may copy hooks to the new repository, depending on its
|
||||
configuration. See the "TEMPLATE DIRECTORY" section 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
|
||||
|
|
@ -45,9 +45,9 @@ HOOKS
|
|||
applypatch-msg
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
This hook is invoked by 'git am'. It takes a single
|
||||
This hook is invoked by linkgit:git-am[1]. It takes a single
|
||||
parameter, the name of the file that holds the proposed commit
|
||||
log message. Exiting with a non-zero status causes 'git am' to abort
|
||||
log message. Exiting with a non-zero status causes `git am` to abort
|
||||
before applying the patch.
|
||||
|
||||
The hook is allowed to edit the message file in place, and can
|
||||
|
|
@ -61,7 +61,7 @@ The default 'applypatch-msg' hook, when enabled, runs the
|
|||
pre-applypatch
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
This hook is invoked by 'git am'. It takes no parameter, and is
|
||||
This hook is invoked by linkgit:git-am[1]. It takes no parameter, and is
|
||||
invoked after the patch is applied, but before a commit is made.
|
||||
|
||||
If it exits with non-zero status, then the working tree will not be
|
||||
|
|
@ -76,33 +76,33 @@ The default 'pre-applypatch' hook, when enabled, runs the
|
|||
post-applypatch
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
This hook is invoked by 'git am'. It takes no parameter,
|
||||
This hook is invoked by linkgit:git-am[1]. It takes no parameter,
|
||||
and is invoked after the patch is applied and a commit is made.
|
||||
|
||||
This hook is meant primarily for notification, and cannot affect
|
||||
the outcome of 'git am'.
|
||||
the outcome of `git am`.
|
||||
|
||||
pre-commit
|
||||
~~~~~~~~~~
|
||||
|
||||
This hook is invoked by 'git commit', and can be bypassed
|
||||
This hook is invoked by linkgit:git-commit[1], and can be bypassed
|
||||
with the `--no-verify` option. It takes no parameters, and is
|
||||
invoked before obtaining the proposed commit log message and
|
||||
making a commit. Exiting with a non-zero status from this script
|
||||
causes the 'git commit' command to abort before creating a commit.
|
||||
causes the `git commit` command to abort before creating a commit.
|
||||
|
||||
The default 'pre-commit' hook, when enabled, catches introduction
|
||||
of lines with trailing whitespaces and aborts the commit when
|
||||
such a line is found.
|
||||
|
||||
All the 'git commit' hooks are invoked with the environment
|
||||
All the `git commit` hooks are invoked with the environment
|
||||
variable `GIT_EDITOR=:` if the command will not bring up an editor
|
||||
to modify the commit message.
|
||||
|
||||
prepare-commit-msg
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This hook is invoked by 'git commit' right after preparing the
|
||||
This hook is invoked by linkgit:git-commit[1] right after preparing the
|
||||
default log message, and before the editor is started.
|
||||
|
||||
It takes one to three parameters. The first is the name of the file
|
||||
|
|
@ -114,7 +114,7 @@ commit is a merge or a `.git/MERGE_MSG` file exists); `squash`
|
|||
(if a `.git/SQUASH_MSG` file exists); or `commit`, followed by
|
||||
a commit SHA-1 (if a `-c`, `-C` or `--amend` option was given).
|
||||
|
||||
If the exit status is non-zero, 'git commit' will abort.
|
||||
If the exit status is non-zero, `git commit` will abort.
|
||||
|
||||
The purpose of the hook is to edit the message file in place, and
|
||||
it is not suppressed by the `--no-verify` option. A non-zero exit
|
||||
|
|
@ -127,7 +127,7 @@ help message found in the commented portion of the commit template.
|
|||
commit-msg
|
||||
~~~~~~~~~~
|
||||
|
||||
This hook is invoked by 'git commit' and 'git merge', and can be
|
||||
This hook is invoked by linkgit:git-commit[1] and linkgit:git-merge[1], and can be
|
||||
bypassed with the `--no-verify` option. It takes a single parameter,
|
||||
the name of the file that holds the proposed commit log message.
|
||||
Exiting with a non-zero status causes the command to abort.
|
||||
|
|
@ -143,16 +143,16 @@ The default 'commit-msg' hook, when enabled, detects duplicate
|
|||
post-commit
|
||||
~~~~~~~~~~~
|
||||
|
||||
This hook is invoked by 'git commit'. It takes no parameters, and is
|
||||
This hook is invoked by linkgit:git-commit[1]. It takes no parameters, and is
|
||||
invoked after a commit is made.
|
||||
|
||||
This hook is meant primarily for notification, and cannot affect
|
||||
the outcome of 'git commit'.
|
||||
the outcome of `git commit`.
|
||||
|
||||
pre-rebase
|
||||
~~~~~~~~~~
|
||||
|
||||
This hook is called by 'git rebase' and can be used to prevent a
|
||||
This hook is called by linkgit:git-rebase[1] and can be used to prevent a
|
||||
branch from getting rebased. The hook may be called with one or
|
||||
two parameters. The first parameter is the upstream from which
|
||||
the series was forked. The second parameter is the branch being
|
||||
|
|
@ -161,17 +161,17 @@ rebased, and is not set when rebasing the current branch.
|
|||
post-checkout
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
This hook is invoked when a 'git checkout' is run after having updated the
|
||||
This hook is invoked when a linkgit:git-checkout[1] is run after having updated the
|
||||
worktree. The hook is given three parameters: the ref of the previous HEAD,
|
||||
the ref of the new HEAD (which may or may not have changed), and a flag
|
||||
indicating whether the checkout was a branch checkout (changing branches,
|
||||
flag=1) or a file checkout (retrieving a file from the index, flag=0).
|
||||
This hook cannot affect the outcome of 'git checkout'.
|
||||
This hook cannot affect the outcome of `git checkout`.
|
||||
|
||||
It is also run after 'git clone', unless the --no-checkout (-n) option is
|
||||
It is also run after linkgit:git-clone[1], unless the `--no-checkout` (`-n`) option is
|
||||
used. The first parameter given to the hook is the null-ref, the second the
|
||||
ref of the new HEAD and the flag is always 1. Likewise for 'git worktree add'
|
||||
unless --no-checkout is used.
|
||||
ref of the new HEAD and the flag is always 1. Likewise for `git worktree add`
|
||||
unless `--no-checkout` is used.
|
||||
|
||||
This hook can be used to perform repository validity checks, auto-display
|
||||
differences from the previous HEAD if different, or set working dir metadata
|
||||
|
|
@ -180,10 +180,10 @@ properties.
|
|||
post-merge
|
||||
~~~~~~~~~~
|
||||
|
||||
This hook is invoked by 'git merge', which happens when a 'git pull'
|
||||
This hook is invoked by linkgit:git-merge[1], which happens when a `git pull`
|
||||
is done on a local repository. The hook takes a single parameter, a status
|
||||
flag specifying whether or not the merge being done was a squash merge.
|
||||
This hook cannot affect the outcome of 'git merge' and is not executed,
|
||||
This hook cannot affect the outcome of `git merge` and is not executed,
|
||||
if the merge failed due to conflicts.
|
||||
|
||||
This hook can be used in conjunction with a corresponding pre-commit hook to
|
||||
|
|
@ -194,10 +194,10 @@ for an example of how to do this.
|
|||
pre-push
|
||||
~~~~~~~~
|
||||
|
||||
This hook is called by 'git push' and can be used to prevent a push from taking
|
||||
place. The hook is called with two parameters which provide the name and
|
||||
location of the destination remote, if a named remote is not being used both
|
||||
values will be the same.
|
||||
This hook is called by linkgit:git-push[1] and can be used to prevent
|
||||
a push from taking place. The hook is called with two parameters
|
||||
which provide the name and location of the destination remote, if a
|
||||
named remote is not being used both values will be the same.
|
||||
|
||||
Information about what is to be pushed is provided on the hook's standard
|
||||
input with lines of the form:
|
||||
|
|
@ -216,7 +216,7 @@ SHA-1>` will be 40 `0`. If the local commit was specified by something other
|
|||
than a name which could be expanded (such as `HEAD~`, or a SHA-1) it will be
|
||||
supplied as it was originally given.
|
||||
|
||||
If this hook exits with a non-zero status, 'git push' will abort without
|
||||
If this hook exits with a non-zero status, `git push` will abort without
|
||||
pushing anything. Information about why the push is rejected may be sent
|
||||
to the user by writing to standard error.
|
||||
|
||||
|
|
@ -224,8 +224,8 @@ to the user by writing to standard error.
|
|||
pre-receive
|
||||
~~~~~~~~~~~
|
||||
|
||||
This hook is invoked by 'git-receive-pack' when it reacts to
|
||||
'git push' and updates reference(s) in its repository.
|
||||
This hook is invoked by linkgit:git-receive-pack[1] when it reacts to
|
||||
`git push` and updates reference(s) in its repository.
|
||||
Just before starting to update refs on the remote repository, the
|
||||
pre-receive hook is invoked. Its exit status determines the success
|
||||
or failure of the update.
|
||||
|
|
@ -246,7 +246,7 @@ updated. If the hook exits with zero, updating of individual refs can
|
|||
still be prevented by the <<update,'update'>> hook.
|
||||
|
||||
Both standard output and standard error output are forwarded to
|
||||
'git send-pack' on the other end, so you can simply `echo` messages
|
||||
`git send-pack` on the other end, so you can simply `echo` messages
|
||||
for the user.
|
||||
|
||||
The number of push options given on the command line of
|
||||
|
|
@ -265,8 +265,8 @@ linkgit:git-receive-pack[1] for some caveats.
|
|||
update
|
||||
~~~~~~
|
||||
|
||||
This hook is invoked by 'git-receive-pack' when it reacts to
|
||||
'git push' and updates reference(s) in its repository.
|
||||
This hook is invoked by linkgit:git-receive-pack[1] when it reacts to
|
||||
`git push` and updates reference(s) in its repository.
|
||||
Just before updating the ref on the remote repository, the update hook
|
||||
is invoked. Its exit status determines the success or failure of
|
||||
the ref update.
|
||||
|
|
@ -279,7 +279,7 @@ three parameters:
|
|||
- and the new object name to be stored in the ref.
|
||||
|
||||
A zero exit from the update hook allows the ref to be updated.
|
||||
Exiting with a non-zero status prevents 'git-receive-pack'
|
||||
Exiting with a non-zero status prevents `git receive-pack`
|
||||
from updating that ref.
|
||||
|
||||
This hook can be used to prevent 'forced' update on certain refs by
|
||||
|
|
@ -299,7 +299,7 @@ membership. See linkgit:git-shell[1] for how you might use the login
|
|||
shell to restrict the user's access to only git commands.
|
||||
|
||||
Both standard output and standard error output are forwarded to
|
||||
'git send-pack' on the other end, so you can simply `echo` messages
|
||||
`git send-pack` on the other end, so you can simply `echo` messages
|
||||
for the user.
|
||||
|
||||
The default 'update' hook, when enabled--and with
|
||||
|
|
@ -310,8 +310,8 @@ unannotated tags to be pushed.
|
|||
post-receive
|
||||
~~~~~~~~~~~~
|
||||
|
||||
This hook is invoked by 'git-receive-pack' when it reacts to
|
||||
'git push' and updates reference(s) in its repository.
|
||||
This hook is invoked by linkgit:git-receive-pack[1] when it reacts to
|
||||
`git push` and updates reference(s) in its repository.
|
||||
It executes on the remote repository once after all the refs have
|
||||
been updated.
|
||||
|
||||
|
|
@ -320,7 +320,7 @@ arguments, but gets the same information as the
|
|||
<<pre-receive,'pre-receive'>>
|
||||
hook does on its standard input.
|
||||
|
||||
This hook does not affect the outcome of 'git-receive-pack', as it
|
||||
This hook does not affect the outcome of `git receive-pack`, as it
|
||||
is called after the real work is done.
|
||||
|
||||
This supersedes the <<post-update,'post-update'>> hook in that it gets
|
||||
|
|
@ -328,7 +328,7 @@ both old and new values of all the refs in addition to their
|
|||
names.
|
||||
|
||||
Both standard output and standard error output are forwarded to
|
||||
'git send-pack' on the other end, so you can simply `echo` messages
|
||||
`git send-pack` on the other end, so you can simply `echo` messages
|
||||
for the user.
|
||||
|
||||
The default 'post-receive' hook is empty, but there is
|
||||
|
|
@ -349,8 +349,8 @@ will be set to zero, `GIT_PUSH_OPTION_COUNT=0`.
|
|||
post-update
|
||||
~~~~~~~~~~~
|
||||
|
||||
This hook is invoked by 'git-receive-pack' when it reacts to
|
||||
'git push' and updates reference(s) in its repository.
|
||||
This hook is invoked by linkgit:git-receive-pack[1] when it reacts to
|
||||
`git push` and updates reference(s) in its repository.
|
||||
It executes on the remote repository once after all the refs have
|
||||
been updated.
|
||||
|
||||
|
|
@ -358,7 +358,7 @@ It takes a variable number of parameters, each of which is the
|
|||
name of ref that was actually updated.
|
||||
|
||||
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,
|
||||
but it does not know what their original and updated values are,
|
||||
|
|
@ -368,20 +368,20 @@ updated values of the refs. You might consider it instead if you need
|
|||
them.
|
||||
|
||||
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
|
||||
a Git repository that is accessible via HTTP, you should
|
||||
probably enable this hook.
|
||||
|
||||
Both standard output and standard error output are forwarded to
|
||||
'git send-pack' on the other end, so you can simply `echo` messages
|
||||
`git send-pack` on the other end, so you can simply `echo` messages
|
||||
for the user.
|
||||
|
||||
push-to-checkout
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
This hook is invoked by 'git-receive-pack' when it reacts to
|
||||
'git push' and updates reference(s) in its repository, and when
|
||||
This hook is invoked by linkgit:git-receive-pack[1] when it reacts to
|
||||
`git push` and updates reference(s) in its repository, and when
|
||||
the push tries to update the branch that is currently checked out
|
||||
and the `receive.denyCurrentBranch` configuration variable is set to
|
||||
`updateInstead`. Such a push by default is refused if the working
|
||||
|
|
@ -400,8 +400,8 @@ when the tip of the current branch is updated to the new commit, and
|
|||
exit with a zero status.
|
||||
|
||||
For example, the hook can simply run `git read-tree -u -m HEAD "$1"`
|
||||
in order to emulate 'git fetch' that is run in the reverse direction
|
||||
with `git push`, as the two-tree form of `read-tree -u -m` is
|
||||
in order to emulate `git fetch` that is run in the reverse direction
|
||||
with `git push`, as the two-tree form of `git read-tree -u -m` is
|
||||
essentially the same as `git checkout` that switches branches while
|
||||
keeping the local changes in the working tree that do not interfere
|
||||
with the difference between the branches.
|
||||
|
|
@ -410,15 +410,16 @@ with the difference between the branches.
|
|||
pre-auto-gc
|
||||
~~~~~~~~~~~
|
||||
|
||||
This hook is invoked by 'git gc --auto'. It takes no parameter, and
|
||||
exiting with non-zero status from this script causes the 'git gc --auto'
|
||||
to abort.
|
||||
This hook is invoked by `git gc --auto` (see linkgit:git-gc[1]). It
|
||||
takes no parameter, and exiting with non-zero status from this script
|
||||
causes the `git gc --auto` to abort.
|
||||
|
||||
post-rewrite
|
||||
~~~~~~~~~~~~
|
||||
|
||||
This hook is invoked by commands that rewrite commits (`git commit
|
||||
--amend`, 'git-rebase'; currently 'git-filter-branch' does 'not' call
|
||||
This hook is invoked by commands that rewrite commits
|
||||
(linkgit:git-commit[1] when called with `--amend` and
|
||||
linkgit:git-rebase[1]; currently `git filter-branch` does 'not' call
|
||||
it!). Its first argument denotes the command it was invoked by:
|
||||
currently one of `amend` or `rebase`. Further command-dependent
|
||||
arguments may be passed in the future.
|
||||
|
|
@ -450,16 +451,16 @@ processed by rebase.
|
|||
sendemail-validate
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This hook is invoked by 'git send-email'. It takes a single parameter,
|
||||
This hook is invoked by linkgit:git-send-email[1]. It takes a single parameter,
|
||||
the name of the file that holds the e-mail to be sent. Exiting with a
|
||||
non-zero status causes 'git send-email' to abort before sending any
|
||||
non-zero status causes `git send-email` to abort before sending any
|
||||
e-mails.
|
||||
|
||||
fsmonitor-watchman
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This hook is invoked when the configuration option core.fsmonitor is
|
||||
set to .git/hooks/fsmonitor-watchman. It takes two arguments, a version
|
||||
This hook is invoked when the configuration option `core.fsmonitor` is
|
||||
set to `.git/hooks/fsmonitor-watchman`. It takes two arguments, a version
|
||||
(currently 1) and the time in elapsed nanoseconds since midnight,
|
||||
January 1, 1970.
|
||||
|
||||
|
|
@ -478,7 +479,7 @@ directories are checked for untracked files based on the path names
|
|||
given.
|
||||
|
||||
An optimized way to tell git "all files have changed" is to return
|
||||
the filename '/'.
|
||||
the filename `/`.
|
||||
|
||||
The exit status determines whether git will use the data from the
|
||||
hook to limit its search. On error, it will fall back to verifying
|
||||
|
|
|
|||
Loading…
Reference in New Issue