Skip to content

Commit

Permalink
Merge branch 'cc/hooks-doc'
Browse files Browse the repository at this point in the history
* cc/hooks-doc:
  Documentation: rename "hooks.txt" to "githooks.txt" and make it a man page
  • Loading branch information
Junio C Hamano committed May 14, 2008
2 parents adf59ec + a5af0e2 commit 29182f7
Show file tree
Hide file tree
Showing 9 changed files with 28 additions and 13 deletions.
5 changes: 2 additions & 3 deletions Documentation/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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))
Expand All @@ -18,7 +18,6 @@ ARTICLES += cvs-migration
ARTICLES += diffcore
ARTICLES += howto-index
ARTICLES += repository-layout
ARTICLES += hooks
ARTICLES += everyday
ARTICLES += git-tools
ARTICLES += glossary
Expand Down
2 changes: 1 addition & 1 deletion Documentation/cvs-migration.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions Documentation/git-commit.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.


Expand Down
2 changes: 1 addition & 1 deletion Documentation/git-rev-parse.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion Documentation/git.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/gitcli.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
gitcli(5)
gitcli(7)
=========

NAME
Expand Down
20 changes: 18 additions & 2 deletions Documentation/hooks.txt → Documentation/githooks.txt
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
2 changes: 1 addition & 1 deletion Documentation/repository-layout.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
2 changes: 1 addition & 1 deletion Documentation/user-manual.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 29182f7

Please sign in to comment.