Documentation: rename "hooks.txt" to "githooks.txt" and make it a man page
Also now "gitcli(5)" becomes "gitcli(7)". Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Christian Couder committed
May 2, 2008 at 05:30 UTC
a5af0e2c550e68b15a38f02ae1d3c3416f8cf276
9 files changed
+28
-13
Documentation/Makefile
+2
-3
@@ -2,8 +2,8 @@ MAN1_TXT= \
2
$(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
3
$(wildcard git-*.txt)) \
4
gitk.txt
5
-MAN5_TXT=gitattributes.txt gitignore.txt gitcli.txt gitmodules.txt
6
-MAN7_TXT=git.txt
5
+MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt githooks.txt
6
+MAN7_TXT=git.txt gitcli.txt
7
8
MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
9
MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT))
@@ -18,7 +18,6 @@ ARTICLES += cvs-migration
18
ARTICLES += diffcore
19
ARTICLES += howto-index
20
ARTICLES += repository-layout
21
-ARTICLES += hooks
21
ARTICLES += everyday
22
ARTICLES += git-tools
23
ARTICLES += glossary
Documentation/cvs-migration.txt
+1
-1
@@ -137,7 +137,7 @@ Advanced Shared Repository Management
137
138
Git allows you to specify scripts called "hooks" to be run at certain
139
points. You can use these, for example, to send all commits to the shared
140
-repository to a mailing list. See link:hooks.html[Hooks used by git].
140
+repository to a mailing list. See linkgit:githooks[5][Hooks used by git].
141
142
You can enforce finer grained permissions using update hooks. See
143
link:howto/update-hook-example.txt[Controlling access to branches using
Documentation/git-commit.txt
+2
-2
@@ -87,7 +87,7 @@ OPTIONS
87
88
--no-verify::
89
This option bypasses the pre-commit and commit-msg hooks.
90
- See also link:hooks.html[hooks].
90
+ See also linkgit:githooks[5][hooks].
91
92
--allow-empty::
93
Usually recording a commit that has the exact same tree as its
@@ -292,7 +292,7 @@ order).
292
HOOKS
293
-----
294
This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`,
295
-and `post-commit` hooks. See link:hooks.html[hooks] for more
295
+and `post-commit` hooks. See linkgit:githooks[5][hooks] for more
296
information.
297
298
Documentation/git-rev-parse.txt
+1
-1
@@ -347,7 +347,7 @@ Each line of options has this format:
347
348
* Use `*` to mean that this option should not be listed in the usage
349
generated for the `-h` argument. It's shown for `--help-all` as
350
- documented in linkgit:gitcli[5].
350
+ documented in linkgit:gitcli[7].
351
352
* Use `!` to not make the corresponding negated long option available.
353
Documentation/git.txt
+1
-1
@@ -364,7 +364,7 @@ File/Directory Structure
364
365
Please see the link:repository-layout.html[repository layout] document.
366
367
-Read link:hooks.html[hooks] for more details about each hook.
367
+Read linkgit:githooks[5][hooks] for more details about each hook.
368
369
Higher level SCMs may provide and manage additional information in the
370
`$GIT_DIR`.
Documentation/gitcli.txt
+1
-1
@@ -1,4 +1,4 @@
1
-gitcli(5)
1
+gitcli(7)
2
=========
3
4
NAME
Documentation/githooks.txt
renamed
+18
-2
@@ -1,5 +1,17 @@
1
-Hooks used by git
2
-=================
1
+githooks(5)
2
+===========
3
+
4
+NAME
5
+----
6
+githooks - Hooks used by git
7
+
8
+SYNOPSIS
9
+--------
10
+$GIT_DIR/hooks/*
11
+
12
+
13
+DESCRIPTION
14
+-----------
15
16
Hooks are little scripts you can place in `$GIT_DIR/hooks`
17
directory to trigger action at certain points. When
@@ -284,3 +296,7 @@ pre-auto-gc
296
This hook is invoked by `git-gc --auto`. It takes no parameter, and
297
exiting with non-zero status from this script causes the `git-gc --auto`
298
to abort.
299
+
300
+GIT
301
+---
302
+Part of the linkgit:git[7] suite
Documentation/repository-layout.txt
+1
-1
@@ -121,7 +121,7 @@ hooks::
121
commands. A handful of sample hooks are installed when
122
`git init` is run, but all of them are disabled by
123
default. To enable, they need to be made executable.
124
- Read link:hooks.html[hooks] for more details about
124
+ Read linkgit:githooks[5][hooks] for more details about
125
each hook.
126
127
index::
Documentation/user-manual.txt
+1
-1
@@ -1881,7 +1881,7 @@ $ chmod a+x hooks/post-update
1881
1882
(For an explanation of the last two lines, see
1883
linkgit:git-update-server-info[1], and the documentation
1884
-link:hooks.html[Hooks used by git].)
1884
+linkgit:githooks[5][Hooks used by git].)
1885
1886
Advertise the URL of proj.git. Anybody else should then be able to
1887
clone or pull from that URL, for example with a command line like: