From a5af0e2c550e68b15a38f02ae1d3c3416f8cf276 Mon Sep 17 00:00:00 2001 From: Christian Couder Date: Fri, 2 May 2008 05:30:47 +0200 Subject: [PATCH] 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 Signed-off-by: Junio C Hamano --- Documentation/Makefile | 5 ++--- Documentation/cvs-migration.txt | 2 +- Documentation/git-commit.txt | 4 ++-- Documentation/git-rev-parse.txt | 2 +- Documentation/git.txt | 2 +- Documentation/gitcli.txt | 2 +- Documentation/{hooks.txt => githooks.txt} | 20 ++++++++++++++++++-- Documentation/repository-layout.txt | 2 +- Documentation/user-manual.txt | 2 +- 9 files changed, 28 insertions(+), 13 deletions(-) rename Documentation/{hooks.txt => githooks.txt} (98%) diff --git a/Documentation/Makefile b/Documentation/Makefile index 43781fb248..4144d1e086 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -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 diff --git a/Documentation/cvs-migration.txt b/Documentation/cvs-migration.txt index 00f2e36b2e..374bc87b10 100644 --- a/Documentation/cvs-migration.txt +++ b/Documentation/cvs-migration.txt @@ -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 diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 4bb51cc06e..c3c9f5b902 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -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. diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt index 110e7ba71f..b6b2fe92a1 100644 --- a/Documentation/git-rev-parse.txt +++ b/Documentation/git-rev-parse.txt @@ -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. diff --git a/Documentation/git.txt b/Documentation/git.txt index 6f445b1e3b..adcd3e00b2 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -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`. diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt index 7ee5ce386f..835cb05f96 100644 --- a/Documentation/gitcli.txt +++ b/Documentation/gitcli.txt @@ -1,4 +1,4 @@ -gitcli(5) +gitcli(7) ========= NAME diff --git a/Documentation/hooks.txt b/Documentation/githooks.txt similarity index 98% rename from Documentation/hooks.txt rename to Documentation/githooks.txt index 1283ab4daa..67c0809f72 100644 --- a/Documentation/hooks.txt +++ b/Documentation/githooks.txt @@ -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 @@ -284,3 +296,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 diff --git a/Documentation/repository-layout.txt b/Documentation/repository-layout.txt index 6939130094..05581c3ec1 100644 --- a/Documentation/repository-layout.txt +++ b/Documentation/repository-layout.txt @@ -121,7 +121,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:: diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 86b91a53e5..e2db850150 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -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: -- 2.11.4.GIT