Merge branch 'cc/hooks-doc'

* cc/hooks-doc:
  Documentation: rename "hooks.txt" to "githooks.txt" and make it a man page
This commit is contained in:
Junio C Hamano 2008-05-14 13:34:23 -07:00
commit 29182f7da4
9 changed files with 28 additions and 13 deletions

View File

@ -2,8 +2,8 @@ MAN1_TXT= \
$(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
$(wildcard git-*.txt)) \
gitk.txt
MAN5_TXT=gitattributes.txt gitignore.txt gitcli.txt gitmodules.txt
MAN7_TXT=git.txt
MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt githooks.txt
MAN7_TXT=git.txt gitcli.txt
MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT))
@ -18,7 +18,6 @@ ARTICLES += cvs-migration
ARTICLES += diffcore
ARTICLES += howto-index
ARTICLES += repository-layout
ARTICLES += hooks
ARTICLES += everyday
ARTICLES += git-tools
ARTICLES += glossary

View File

@ -137,7 +137,7 @@ Advanced Shared Repository Management
Git allows you to specify scripts called "hooks" to be run at certain
points. You can use these, for example, to send all commits to the shared
repository to a mailing list. See link:hooks.html[Hooks used by git].
repository to a mailing list. See linkgit:githooks[5][Hooks used by git].
You can enforce finer grained permissions using update hooks. See
link:howto/update-hook-example.txt[Controlling access to branches using

View File

@ -87,7 +87,7 @@ OPTIONS
--no-verify::
This option bypasses the pre-commit and commit-msg hooks.
See also link:hooks.html[hooks].
See also linkgit:githooks[5][hooks].
--allow-empty::
Usually recording a commit that has the exact same tree as its
@ -292,7 +292,7 @@ order).
HOOKS
-----
This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`,
and `post-commit` hooks. See link:hooks.html[hooks] for more
and `post-commit` hooks. See linkgit:githooks[5][hooks] for more
information.

View File

@ -347,7 +347,7 @@ Each line of options has this format:
* Use `*` to mean that this option should not be listed in the usage
generated for the `-h` argument. It's shown for `--help-all` as
documented in linkgit:gitcli[5].
documented in linkgit:gitcli[7].
* Use `!` to not make the corresponding negated long option available.

View File

@ -364,7 +364,7 @@ File/Directory Structure
Please see the link:repository-layout.html[repository layout] document.
Read link:hooks.html[hooks] for more details about each hook.
Read linkgit:githooks[5][hooks] for more details about each hook.
Higher level SCMs may provide and manage additional information in the
`$GIT_DIR`.

View File

@ -1,4 +1,4 @@
gitcli(5)
gitcli(7)
=========
NAME

View File

@ -1,5 +1,17 @@
Hooks used by git
=================
githooks(5)
===========
NAME
----
githooks - Hooks used by git
SYNOPSIS
--------
$GIT_DIR/hooks/*
DESCRIPTION
-----------
Hooks are little scripts you can place in `$GIT_DIR/hooks`
directory to trigger action at certain points. When
@ -285,3 +297,7 @@ 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.
GIT
---
Part of the linkgit:git[7] suite

View File

@ -124,7 +124,7 @@ hooks::
commands. A handful of sample hooks are installed when
`git init` is run, but all of them are disabled by
default. To enable, they need to be made executable.
Read link:hooks.html[hooks] for more details about
Read linkgit:githooks[5][hooks] for more details about
each hook.
index::

View File

@ -1881,7 +1881,7 @@ $ chmod a+x hooks/post-update
(For an explanation of the last two lines, see
linkgit:git-update-server-info[1], and the documentation
link:hooks.html[Hooks used by git].)
linkgit:githooks[5][Hooks used by git].)
Advertise the URL of proj.git. Anybody else should then be able to
clone or pull from that URL, for example with a command line like: