From 2fbcd210effb63ce172dc7002701b015a4a0f5a2 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Wed, 14 May 2008 22:26:07 +0000 Subject: [PATCH] Autogenerated HTML docs for v1.5.5.1-248-g4b17 --- cvs-migration.html | 4 +- cvs-migration.txt | 2 +- git-commit.html | 6 +- git-commit.txt | 4 +- git-config.html | 12 +- git-describe.html | 9 +- git-describe.txt | 7 +- git-format-patch.html | 5 +- git-format-patch.txt | 1 + git-merge.html | 12 +- git-rev-parse.html | 4 +- git-rev-parse.txt | 2 +- git.html | 4 +- git.txt | 2 +- gitcli.html | 6 +- gitcli.txt | 2 +- githooks.html | 532 ++++++++++++++++++++++++++++++++++++++ hooks.txt => githooks.txt | 20 +- merge-config.txt | 5 + repository-layout.html | 4 +- repository-layout.txt | 2 +- user-manual.html | 2 +- user-manual.txt | 2 +- 23 files changed, 613 insertions(+), 36 deletions(-) create mode 100644 githooks.html rename hooks.txt => githooks.txt (98%) diff --git a/cvs-migration.html b/cvs-migration.html index 69224bb54..93ab28500 100644 --- a/cvs-migration.html +++ b/cvs-migration.html @@ -386,7 +386,7 @@ necessary.

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 Hooks used by git.

+repository to a mailing list. See githooks(5)[Hooks used by git].

You can enforce finer grained permissions using update hooks. See Controlling access to branches using update hooks.

@@ -417,7 +417,7 @@ repositories without the need for a central maintainer.

diff --git a/cvs-migration.txt b/cvs-migration.txt index 00f2e36b2..374bc87b1 100644 --- a/cvs-migration.txt +++ b/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/git-commit.html b/git-commit.html index 0b1c56969..19da70110 100644 --- a/git-commit.html +++ b/git-commit.html @@ -405,7 +405,7 @@ that, you can recover from it with git-reset(1).

This option bypasses the pre-commit and commit-msg hooks. - See also hooks. + See also githooks(5)[hooks].

@@ -724,7 +724,7 @@ order).

HOOKS

This command can run commit-msg, prepare-commit-msg, pre-commit, -and post-commit hooks. See hooks for more +and post-commit hooks. See githooks(5)[hooks] for more information.

DESCRIPTION

The command finds the most recent tag that is reachable from a -commit, and if the commit itself is pointed at by the tag, shows -the tag. Otherwise, it suffixes the tag name with the number of -additional commits and the abbreviated object name of the commit.

+commit. If the tag points to the commit, then only the tag is +shown. Otherwise, it suffixes the tag name with the number of +additional commits on top of the tagged object and the +abbreviated object name of the most recent commit.

OPTIONS

@@ -461,7 +462,7 @@ updated by Shawn Pearce <spearce@spearce.org>.

diff --git a/git-describe.txt b/git-describe.txt index d9aa2f298..69e1ab750 100644 --- a/git-describe.txt +++ b/git-describe.txt @@ -13,9 +13,10 @@ SYNOPSIS DESCRIPTION ----------- The command finds the most recent tag that is reachable from a -commit, and if the commit itself is pointed at by the tag, shows -the tag. Otherwise, it suffixes the tag name with the number of -additional commits and the abbreviated object name of the commit. +commit. If the tag points to the commit, then only the tag is +shown. Otherwise, it suffixes the tag name with the number of +additional commits on top of the tagged object and the +abbreviated object name of the most recent commit. OPTIONS diff --git a/git-format-patch.html b/git-format-patch.html index 844ec36ef..53b50d532 100644 --- a/git-format-patch.html +++ b/git-format-patch.html @@ -998,7 +998,8 @@ and file suffix, and number patches when outputting more than one.

headers = "Organization: git-foo\n" subjectprefix = CHANGE suffix = .txt - numbered = auto + numbered = auto + cc = <email>

EXAMPLES

@@ -1079,7 +1080,7 @@ as e-mailable patches: diff --git a/git-format-patch.txt b/git-format-patch.txt index 7548a21d3..c60ce123e 100644 --- a/git-format-patch.txt +++ b/git-format-patch.txt @@ -174,6 +174,7 @@ and file suffix, and number patches when outputting more than one. subjectprefix = CHANGE suffix = .txt numbered = auto + cc = ------------ diff --git a/git-merge.html b/git-merge.html index e166586d5..02a154c00 100644 --- a/git-merge.html +++ b/git-merge.html @@ -523,6 +523,16 @@ merge.log

+merge.renameLimit +

+ The number of files to consider when performing rename detection + during a merge; if not specified, defaults to the value of + diff.renameLimit. +

merge.tool

@@ -739,7 +749,7 @@ Resolve the conflicts. git-diff would report only the diff --git a/git-rev-parse.html b/git-rev-parse.html index 785ccf1ab..b3f7a956b 100644 --- a/git-rev-parse.html +++ b/git-rev-parse.html @@ -816,7 +816,7 @@ Use ? to mean that the option is optional (though its use is discourage

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 gitcli(5). + documented in gitcli(7).

@@ -866,7 +866,7 @@ Junio C Hamano <junkio@cox.net> and Pierre Habouzit <madcoder@debian.or diff --git a/git-rev-parse.txt b/git-rev-parse.txt index 110e7ba71..b6b2fe92a 100644 --- a/git-rev-parse.txt +++ b/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/git.html b/git.html index f02fdf01b..ea7673a37 100644 --- a/git.html +++ b/git.html @@ -1629,7 +1629,7 @@ HEAD

File/Directory Structure

Please see the repository layout document.

Read hooks for more details about each hook.

Read githooks(5)[hooks] for more details about each hook.

Higher level SCMs may provide and manage additional information in the $GIT_DIR.

@@ -1952,7 +1952,7 @@ contributors on the git-list <git@vger.kernel.org>.

diff --git a/git.txt b/git.txt index 6f445b1e3..adcd3e00b 100644 --- a/git.txt +++ b/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/gitcli.html b/gitcli.html index 743d6ab92..cd49a6909 100644 --- a/gitcli.html +++ b/gitcli.html @@ -256,12 +256,12 @@ div.exampleblock-content { padding-left: 0.5em; } -gitcli(5) +gitcli(7)

-gitcli(5) Manual Page +gitcli(7) Manual Page

NAME

@@ -388,7 +388,7 @@ $ git describe --abbrev 10 HEAD # NOT WHAT YOU MEANT

diff --git a/gitcli.txt b/gitcli.txt index 7ee5ce386..835cb05f9 100644 --- a/gitcli.txt +++ b/gitcli.txt @@ -1,4 +1,4 @@ -gitcli(5) +gitcli(7) ========= NAME diff --git a/githooks.html b/githooks.html new file mode 100644 index 000000000..2c03526ef --- /dev/null +++ b/githooks.html @@ -0,0 +1,532 @@ + + + + + + +githooks(5) + + + +

SYNOPSIS

$GIT_DIR/hooks/*

DESCRIPTION

Hooks are little scripts you can place in $GIT_DIR/hooks +directory to trigger action at certain points. When +git-init is run, a handful example hooks are copied in the +hooks directory of the new repository, but by default they are +all disabled. To enable a hook, make it executable with chmod +x.

This document describes the currently defined hooks.

applypatch-msg

This hook is invoked by git-am script. It takes a single +parameter, the name of the file that holds the proposed commit +log message. Exiting with 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 +be used to normalize the message into some project standard +format (if the project has one). It can also be used to refuse +the commit after inspecting the message file.

The default applypatch-msg hook, when enabled, runs the +commit-msg hook, if the latter is enabled.

pre-applypatch

This hook is invoked by git-am. 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 +committed after applying the patch.

It can be used to inspect the current working tree and refuse to +make a commit if it does not pass certain test.

The default pre-applypatch hook, when enabled, runs the +pre-commit hook, if the latter is enabled.

post-applypatch

This hook is invoked by git-am. 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.

pre-commit

This hook is invoked by git-commit, and can be bypassed +with --no-verify option. It takes no parameter, and is +invoked before obtaining the proposed commit log message and +making a commit. Exiting with non-zero status from this script +causes the git-commit to abort.

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 +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 +default log message, and before the editor is started.

It takes one to three parameters. The first is the name of the file +that the commit log message. The second is the source of the commit +message, and can be: message (if a \-m or \-F option was +given); template (if a \-t option was given or the +configuration option commit.template is set); merge (if the +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 SHA1 (if a \-c, \-C or --amend option was given).

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 +means a failure of the hook and aborts the commit. It should not +be used as replacement for pre-commit hook.

The sample prepare-commit-msg hook that comes with git comments +out the Conflicts: part of a merge's commit message.

commit-msg

This hook is invoked by git-commit, and can be bypassed +with --no-verify option. It takes a single parameter, the +name of the file that holds the proposed commit log message. +Exiting with non-zero status causes the git-commit to +abort.

The default commit-msg hook, when enabled, detects duplicate +"Signed-off-by" lines, and aborts the commit if one is found.

post-commit

This hook is invoked by git-commit. It takes no +parameter, and is invoked after a commit is made.

This hook is meant primarily for notification, and cannot affect +the outcome of git-commit.

post-checkout

This hook is invoked when a git-checkout 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 can be used to perform repository validity checks, auto-display +differences from the previous HEAD if different, or set working dir metadata +properties.

post-merge

This hook is invoked by git-merge, 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, +if the merge failed due to conflicts.

This hook can be used in conjunction with a corresponding pre-commit hook to +save and restore any form of metadata associated with the working tree +(eg: permissions/ownership, ACLS, etc). See contrib/hooks/setgitperms.perl +for an example of how to do this.

pre-receive

This hook is invoked by git-receive-pack on the remote repository, +which happens when a git push is done on a local 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.

This hook executes once for the receive operation. It takes no +arguments, but for each ref to be updated it receives on standard +input a line of the format:

<old-value> SP <new-value> SP <ref-name> LF

where <old-value> is the old object name stored in the ref, +<new-value> is the new object name to be stored in the ref and +<ref-name> is the full name of the ref. +When creating a new ref, <old-value> is 40 0.

If the hook exits with non-zero status, none of the refs will be +updated. If the hook exits with zero, updating of individual refs can +still be prevented by the 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 +for the user.

update

This hook is invoked by git-receive-pack on the remote repository, +which happens when a git push is done on a local 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.

The hook executes once for each ref to be updated, and takes +three parameters:

+
+the name of the ref being updated, +
+
+
+the old object name stored in the ref, +
+
+
+and the new objectname 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 +from updating that ref.

This hook can be used to prevent forced update on certain refs by +making sure that the object name is a commit object that is a +descendant of the commit object named by the old object name. +That is, to enforce a "fast forward only" policy.

It could also be used to log the old..new status. However, it +does not know the entire set of branches, so it would end up +firing one e-mail per ref when used naively, though. The +post-receive hook is more suited to that.

Another use suggested on the mailing list is to use this hook to +implement access control which is finer grained than the one +based on filesystem group.

Both standard output and standard error output are forwarded to +git-send-pack on the other end, so you can simply echo messages +for the user.

The default update hook, when enabled--and with +hooks.allowunannotated config option turned on--prevents +unannotated tags to be pushed.

post-receive

This hook is invoked by git-receive-pack on the remote repository, +which happens when a git push is done on a local repository. +It executes on the remote repository once after all the refs have +been updated.

This hook executes once for the receive operation. It takes no +arguments, but gets the same information as the +pre-receive +hook does on its standard input.

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 hook in that it gets +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 +for the user.

The default post-receive hook is empty, but there is +a sample script post-receive-email provided in the contrib/hooks +directory in git distribution, which implements sending commit +emails.

post-update

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 post-update hook can tell what are the heads that were pushed, +but it does not know what their original and updated values are, +so it is a poor place to do log old..new. The +post-receive hook does get both original and +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 +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 +for the user.

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 git(7) suite

+ + + diff --git a/hooks.txt b/githooks.txt similarity index 98% rename from hooks.txt rename to githooks.txt index d89cc2226..53747febd 100644 --- a/hooks.txt +++ b/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 @@ -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 diff --git a/merge-config.txt b/merge-config.txt index 9719311b4..48ce747cf 100644 --- a/merge-config.txt +++ b/merge-config.txt @@ -6,6 +6,11 @@ merge.log:: Whether to include summaries of merged commits in newly created merge commit messages. False by default. +merge.renameLimit:: + The number of files to consider when performing rename detection + during a merge; if not specified, defaults to the value of + diff.renameLimit. + merge.tool:: Controls which merge resolution program is used by linkgit:git-mergetool[1]. Valid built-in values are: "kdiff3", diff --git a/repository-layout.html b/repository-layout.html index 3e4a9d942..2ddbbe3c3 100644 --- a/repository-layout.html +++ b/repository-layout.html @@ -472,7 +472,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 hooks for more details about + Read githooks(5)[hooks] for more details about each hook.

@@ -585,7 +585,7 @@ shallow diff --git a/repository-layout.txt b/repository-layout.txt index bbaed2e12..7fd187be8 100644 --- a/repository-layout.txt +++ b/repository-layout.txt @@ -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:: diff --git a/user-manual.html b/user-manual.html index 664ff1134..71d5f8e44 100644 --- a/user-manual.html +++ b/user-manual.html @@ -734,7 +734,7 @@ $Â cdÂ proj.git
$Â gitÂ --bareÂ update-server-info
$Â chmodÂ a+xÂ hooks/post-update

(For an explanation of the last two lines, see git-update-server-info(1), and the documentation -Hooks used by git.)

Advertise the URL of proj.git. Anybody else should then be able to +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:

$Â gitÂ cloneÂ http://yourserver.com/~you/proj.git

(See also setup-git-server-over-http for a slightly more sophisticated setup using WebDAV which also diff --git a/user-manual.txt b/user-manual.txt index 86b91a53e..e2db85015 100644 --- a/user-manual.txt +++ b/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.26.2

HOOKS

SEE ALSO

DESCRIPTION

OPTIONS

EXAMPLES

File/Directory Structure

-gitcli(5) Manual Page +gitcli(7) Manual Page

NAME

+githooks(5) Manual Page +

NAME

SYNOPSIS

DESCRIPTION

applypatch-msg

pre-applypatch

post-applypatch

pre-commit

prepare-commit-msg

commit-msg

post-commit

post-checkout

post-merge

pre-receive

update

post-receive

post-update

pre-auto-gc

GIT