path: root/Documentation/hooks.txt
AgeCommit message (Collapse)Author
2008-02-06git-commit: add a prepare-commit-msg hookPaolo Bonzini
The prepare-commit-msg hook is run whenever a "fresh" commit message is prepared, just before it is shown in the editor (if it is). Its purpose is to modify the commit message in-place. 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 as the third parameter (if a -c, -C or --amend option was given). If its exit status is non-zero, git-commit will abort. The hook is not suppressed by the --no-verify option, so it should not be used as a replacement for the pre-commit hook. The sample prepare-commit-msg comments out the `Conflicts:` part of a merge's commit message; other examples are commented out, including adding a Signed-off-by line at the bottom of the commit messsage, that the user can then edit or discard altogether. Signed-off-by: Paolo Bonzini <> Signed-off-by: Junio C Hamano <>
2008-02-06git-commit: set GIT_EDITOR=: if editor will not be launchedPaolo Bonzini
This is a preparatory patch that provides a simple way for the future prepare-commit-msg hook to discover if the editor will be launched. Signed-off-by: Junio C Hamano <>
2007-09-30post-checkout hook, tests, and docsJosh England
Updated post-checkout hook to take a flag specifying whether the checkout is a branch checkout or a file checkout (from the index). Signed-off-by: Josh England <> Signed-off-by: Junio C Hamano <>
2007-09-19Added example hook script to save/restore permissions/ownership.Josh England
Usage info is emebed in the script, but the gist of it is to run the script from a pre-commit hook to save permissions/ownership data to a file and check that file into the repository. Then, a post_merge hook reads the file and updates working tree permissions/ownership. All updates are transparent to the user (although there is a --verbose option). Merge conflicts are handled in the "read" phase (in pre-commit), and the script aborts the commit and tells you how to fix things in the case of a merge conflict in the metadata file. This same idea could be extended to handle file ACLs or other file metadata if desired. Signed-off-by: Josh England <> Signed-off-by: Junio C Hamano <>
2007-09-19Add post-merge hook, related documentation, and tests.Josh England
The post-merge hook enables one to hook in for `git pull` operations in order to check and/or change attributes of a work tree from the hook. As an example, it can be used in combination with a pre-commit hook to save/restore file ownership and permissions data (or file ACLs) within the repository and transparently update the working tree after a `git pull` operation. Signed-off-by: Josh England <> Signed-off-by: Junio C Hamano <>
2007-08-25Documentation: Correct various misspellings and typos.Brian Hetro
Fix minor typos throughout the documentation. Signed-off-by: Brian Hetro <> Signed-off-by: Junio C Hamano <>
2007-05-25Remove git-applypatchJunio C Hamano
The previous one removed git-applymbox, which was the sole user of this tool. Signed-off-by: Junio C Hamano <>
2007-05-25git-applymbox: Remove commandPetr Baudis
I believe noone uses git-applymbox, and noone definitely should, since it is supposed to be completely superseded and everything by its younger cousin git-am. The only known person in the universe to use it was Linus and he declared some time ago that he will try to use git-am instead in his famous dotest script. The trouble is that git-applymbox existence creates confusing UI. I'm a bit like a recycled newbie to the git porcelain and *I* was confused by git-applymbox primitiveness until I've realized a while later that I'm of course using the wrong command. Signed-off-by: Petr Baudis <> Signed-off-by: Junio C Hamano <>
2007-05-12Minor fixup to documentation of hooks in git-receive-pack.Jan Hudec
Small additional changes to the cbb84e5d174cf33fd4dcf3136de50a886ff9a2e2 commit, which introduced documentation to pre-receive and post-receive: - Mention that stdout and stderr are equivalent. - Add one cross-section link and fix one other. - Fix information on advantages of post-receive over post-update. Signed-off-by: Jan Hudec <> Signed-off-by: Junio C Hamano <>
2007-05-12Updated documentation of hooks in git-receive-pack.Jan Hudec
Added documentation of pre-receive and post-receive hooks and updated documentation of update and post-update hooks. [jc: with minor copy-editing] Signed-off-by: Jan Hudec <> Signed-off-by: Junio C Hamano <>
2007-02-03doc: hooks.txt said post-commit default sends an email, it doesn'tAndy Parkins
The default post-commit hook is actually empty; it is the update hook that sends an email. This patch corrects hooks.txt to reflect that. Signed-off-by: Andy Parkins <> Signed-off-by: Junio C Hamano <>
2007-01-12use 'init' instead of 'init-db' for shipped docs and toolsNicolas Pitre
While 'init-db' still is and probably will always remain a valid git command for obvious backward compatibility reasons, it would be a good idea to move shipped tools and docs to using 'init' instead. Signed-off-by: Nicolas Pitre <> Signed-off-by: Junio C Hamano <>
2006-12-31Update documentation for update hook.Junio C Hamano
Signed-off-by: Junio C Hamano <>
2006-09-20Fix trivial typos and inconsistencies in hooks documentationJonas Fonseca
Pointed out by Alan Chandler. Signed-off-by: Jonas Fonseca <> Signed-off-by: Junio C Hamano <>
2006-06-07Some doc typo fixesFrancis Daly
All should be clear enough, except perhaps committish / commitish. I just kept the more-used one within the current docs. [jc: with rephrasing of check-ref-format description later discussed on the list] Signed-off-by: Francis Daly <> Signed-off-by: Junio C Hamano <>
2006-06-04Documentation: Spelling fixesHorst H. von Brand
Signed-off-by: Horst H. von Brand <> Signed-off-by: Junio C Hamano <>
2006-03-25Clarify and expand some hook documentation.Jon Loeliger
Clarify update and post-update hooks. Made a few references to the hooks documentation. Signed-off-by: Jon Loeliger <> Signed-off-by: Junio C Hamano <>
2005-12-20Documentation: stdout of update-hook is connected to /dev/nullJunio C Hamano
Mention that update-hook does not emit its stdout to the sender. Signed-off-by: Junio C Hamano <>
2005-10-10Convert usage of GIT and Git into gitChristian Meder
Convert usage of GIT and Git into git. Signed-off-by: Christian Meder <> Signed-off-by: Junio C Hamano <>
2005-10-10Remove the version tags from the manpagesJunio C Hamano
Signed-off-by: Christian Meder <> Signed-off-by: Junio C Hamano <>
2005-09-11[PATCH] Escape asciidoc's built-in em-dash replacementYasushi SHOJI
AsciiDoc replace '--' with em-dash (&#8212) by default. em-dash looks a lot like a single long dash and it's very confusing when we are talking about command options. Section 21.2.8 'Replacements' of AsciiDoc's User Guide says that a backslash in front of double dash prevent the replacement. This patch does just that. Signed-off-by: Yasushi SHOJI <> Signed-off-by: Junio C Hamano <>
2005-09-08Big tool rename.Junio C Hamano
As promised, this is the "big tool rename" patch. The primary differences since 0.99.6 are: (1) git-*-script are no more. The commands installed do not have any such suffix so users do not have to remember if something is implemented as a shell script or not. (2) Many command names with 'cache' in them are renamed with 'index' if that is what they mean. There are backward compatibility symblic links so that you and Porcelains can keep using the old names, but the backward compatibility support is expected to be removed in the near future. Signed-off-by: Junio C Hamano <>
2005-09-03Document hooks.Junio C Hamano
Signed-off-by: Junio C Hamano <>