blob: 0bd6d2f8ed0fd29f9022bf21a05fd1f0d3228d96 [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:231<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Junio C Hamano818f7d62006-03-26 01:49:306<meta name="generator" content="AsciiDoc 7.0.2" />
Junio C Hamano1a4e8412005-12-27 08:17:237<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
19a { color: blue; }
20a:visited { color: fuchsia; }
21
22em {
23 font-style: italic;
24}
25
26strong {
27 font-weight: bold;
28}
29
30tt {
31 color: navy;
32}
33
34h1, h2, h3, h4, h5, h6 {
35 color: #527bbd;
36 font-family: sans-serif;
37 margin-top: 1.2em;
38 margin-bottom: 0.5em;
39 line-height: 1.3;
40}
41
42h1 {
43 border-bottom: 2px solid silver;
44}
45h2 {
46 border-bottom: 2px solid silver;
47 padding-top: 0.5em;
48}
49
50div.sectionbody {
51 font-family: serif;
52 margin-left: 0;
53}
54
55hr {
56 border: 1px solid silver;
57}
58
59p {
60 margin-top: 0.5em;
61 margin-bottom: 0.5em;
62}
63
64pre {
65 padding: 0;
66 margin: 0;
67}
68
69span#author {
70 color: #527bbd;
71 font-family: sans-serif;
72 font-weight: bold;
73 font-size: 1.2em;
74}
75span#email {
76}
77span#revision {
78 font-family: sans-serif;
79}
80
81div#footer {
82 font-family: sans-serif;
83 font-size: small;
84 border-top: 2px solid silver;
85 padding-top: 0.5em;
86 margin-top: 4.0em;
87}
88div#footer-text {
89 float: left;
90 padding-bottom: 0.5em;
91}
92div#footer-badges {
93 float: right;
94 padding-bottom: 0.5em;
95}
96
97div#preamble,
98div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
99div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
100div.admonitionblock {
101 margin-right: 10%;
102 margin-top: 1.5em;
103 margin-bottom: 1.5em;
104}
105div.admonitionblock {
106 margin-top: 2.5em;
107 margin-bottom: 2.5em;
108}
109
110div.content { /* Block element content. */
111 padding: 0;
112}
113
114/* Block element titles. */
115div.title, caption.title {
116 font-family: sans-serif;
117 font-weight: bold;
118 text-align: left;
119 margin-top: 1.0em;
120 margin-bottom: 0.5em;
121}
122div.title + * {
123 margin-top: 0;
124}
125
126td div.title:first-child {
127 margin-top: 0.0em;
128}
129div.content div.title:first-child {
130 margin-top: 0.0em;
131}
132div.content + div.title {
133 margin-top: 0.0em;
134}
135
136div.sidebarblock > div.content {
137 background: #ffffee;
138 border: 1px solid silver;
139 padding: 0.5em;
140}
141
142div.listingblock > div.content {
143 border: 1px solid silver;
144 background: #f4f4f4;
145 padding: 0.5em;
146}
147
148div.quoteblock > div.content {
149 padding-left: 2.0em;
150}
151div.quoteblock .attribution {
152 text-align: right;
153}
154
155div.admonitionblock .icon {
156 vertical-align: top;
157 font-size: 1.1em;
158 font-weight: bold;
159 text-decoration: underline;
160 color: #527bbd;
161 padding-right: 0.5em;
162}
163div.admonitionblock td.content {
164 padding-left: 0.5em;
165 border-left: 2px solid silver;
166}
167
168div.exampleblock > div.content {
169 border-left: 2px solid silver;
170 padding: 0.5em;
171}
172
173div.verseblock div.content {
174 white-space: pre;
175}
176
177div.imageblock div.content { padding-left: 0; }
178div.imageblock img { border: 1px solid silver; }
179span.image img { border-style: none; }
180
181dl {
182 margin-top: 0.8em;
183 margin-bottom: 0.8em;
184}
185dt {
186 margin-top: 0.5em;
187 margin-bottom: 0;
188 font-style: italic;
189}
190dd > *:first-child {
191 margin-top: 0;
192}
193
194ul, ol {
195 list-style-position: outside;
196}
197ol.olist2 {
198 list-style-type: lower-alpha;
199}
200
201div.tableblock > table {
202 border-color: #527bbd;
203 border-width: 3px;
204}
205thead {
206 font-family: sans-serif;
207 font-weight: bold;
208}
209tfoot {
210 font-weight: bold;
211}
212
213div.hlist {
214 margin-top: 0.8em;
215 margin-bottom: 0.8em;
216}
217td.hlist1 {
218 vertical-align: top;
219 font-style: italic;
220 padding-right: 0.8em;
221}
222td.hlist2 {
223 vertical-align: top;
224}
225
226@media print {
227 div#footer-badges { display: none; }
228}
229/* Workarounds for IE6's broken and incomplete CSS2. */
230
231div.sidebar-content {
232 background: #ffffee;
233 border: 1px solid silver;
234 padding: 0.5em;
235}
236div.sidebar-title, div.image-title {
237 font-family: sans-serif;
238 font-weight: bold;
239 margin-top: 0.0em;
240 margin-bottom: 0.5em;
241}
242
243div.listingblock div.content {
244 border: 1px solid silver;
245 background: #f4f4f4;
246 padding: 0.5em;
247}
248
249div.quoteblock-content {
250 padding-left: 2.0em;
251}
252
253div.exampleblock-content {
254 border-left: 2px solid silver;
255 padding-left: 0.5em;
256}
257</style>
258<title>Hooks used by git</title>
259</head>
260<body>
261<div id="header">
262<h1>Hooks used by git</h1>
263</div>
264<div id="preamble">
265<div class="sectionbody">
266<p>Hooks are little scripts you can place in <tt>$GIT_DIR/hooks</tt>
267directory to trigger action at certain points. When
268<tt>git-init-db</tt> is run, a handful example hooks are copied in the
269<tt>hooks</tt> directory of the new repository, but by default they are
Junio C Hamanod5784132006-09-20 21:29:27270all disabled. To enable a hook, make it executable with <tt>chmod +x</tt>.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23271<p>This document describes the currently defined hooks.</p>
272</div>
273</div>
274<h2>applypatch-msg</h2>
275<div class="sectionbody">
276<p>This hook is invoked by <tt>git-applypatch</tt> script, which is
277typically invoked by <tt>git-applymbox</tt>. It takes a single
278parameter, the name of the file that holds the proposed commit
Junio C Hamanod5784132006-09-20 21:29:27279log message. Exiting with non-zero status causes
280<tt>git-applypatch</tt> to abort before applying the patch.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23281<p>The hook is allowed to edit the message file in place, and can
282be used to normalize the message into some project standard
283format (if the project has one). It can also be used to refuse
284the commit after inspecting the message file.</p>
Junio C Hamanod5784132006-09-20 21:29:27285<p>The default <em>applypatch-msg</em> hook, when enabled, runs the
286<em>commit-msg</em> hook, if the latter is enabled.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23287</div>
288<h2>pre-applypatch</h2>
289<div class="sectionbody">
290<p>This hook is invoked by <tt>git-applypatch</tt> script, which is
291typically invoked by <tt>git-applymbox</tt>. It takes no parameter,
292and is invoked after the patch is applied, but before a commit
293is made. Exiting with non-zero status causes the working tree
294after application of the patch not committed.</p>
295<p>It can be used to inspect the current working tree and refuse to
296make a commit if it does not pass certain test.</p>
Junio C Hamanod5784132006-09-20 21:29:27297<p>The default <em>pre-applypatch</em> hook, when enabled, runs the
298<em>pre-commit</em> hook, if the latter is enabled.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23299</div>
300<h2>post-applypatch</h2>
301<div class="sectionbody">
302<p>This hook is invoked by <tt>git-applypatch</tt> script, which is
303typically invoked by <tt>git-applymbox</tt>. It takes no parameter,
304and is invoked after the patch is applied and a commit is made.</p>
305<p>This hook is meant primarily for notification, and cannot affect
306the outcome of <tt>git-applypatch</tt>.</p>
307</div>
308<h2>pre-commit</h2>
309<div class="sectionbody">
310<p>This hook is invoked by <tt>git-commit</tt>, and can be bypassed
311with <tt>--no-verify</tt> option. It takes no parameter, and is
312invoked before obtaining the proposed commit log message and
313making a commit. Exiting with non-zero status from this script
314causes the <tt>git-commit</tt> to abort.</p>
Junio C Hamanod5784132006-09-20 21:29:27315<p>The default <em>pre-commit</em> hook, when enabled, catches introduction
Junio C Hamano1a4e8412005-12-27 08:17:23316of lines with trailing whitespaces and aborts the commit when
Junio C Hamanod5784132006-09-20 21:29:27317such a line is found.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23318</div>
319<h2>commit-msg</h2>
320<div class="sectionbody">
321<p>This hook is invoked by <tt>git-commit</tt>, and can be bypassed
322with <tt>--no-verify</tt> option. It takes a single parameter, the
323name of the file that holds the proposed commit log message.
324Exiting with non-zero status causes the <tt>git-commit</tt> to
325abort.</p>
326<p>The hook is allowed to edit the message file in place, and can
327be used to normalize the message into some project standard
328format (if the project has one). It can also be used to refuse
329the commit after inspecting the message file.</p>
Junio C Hamanod5784132006-09-20 21:29:27330<p>The default <em>commit-msg</em> hook, when enabled, detects duplicate
331"Signed-off-by" lines, and aborts the commit if one is found.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23332</div>
333<h2>post-commit</h2>
334<div class="sectionbody">
335<p>This hook is invoked by <tt>git-commit</tt>. It takes no
336parameter, and is invoked after a commit is made.</p>
337<p>This hook is meant primarily for notification, and cannot affect
338the outcome of <tt>git-commit</tt>.</p>
Junio C Hamanod5784132006-09-20 21:29:27339<p>The default <em>post-commit</em> hook, when enabled, demonstrates how to
Junio C Hamano1a4e8412005-12-27 08:17:23340send out a commit notification e-mail.</p>
341</div>
342<h2>update</h2>
343<div class="sectionbody">
Junio C Hamano818f7d62006-03-26 01:49:30344<p>This hook is invoked by <tt>git-receive-pack</tt> on the remote repository,
Junio C Hamanod5784132006-09-20 21:29:27345which happens when a <tt>git push</tt> is done on a local repository.
Junio C Hamano818f7d62006-03-26 01:49:30346Just before updating the ref on the remote repository, the update hook
Junio C Hamano33db4372006-06-07 19:51:45347is invoked. Its exit status determines the success or failure of
Junio C Hamano818f7d62006-03-26 01:49:30348the ref update.</p>
349<p>The hook executes once for each ref to be updated, and takes
Junio C Hamanod5784132006-09-20 21:29:27350three parameters:</p>
351<ul>
352<li>
353<p>
354the name of the ref being updated,
355</p>
356</li>
357<li>
358<p>
359the old object name stored in the ref,
360</p>
361</li>
362<li>
363<p>
364and the new objectname to be stored in the ref.
365</p>
366</li>
367</ul>
Junio C Hamano818f7d62006-03-26 01:49:30368<p>A zero exit from the update hook allows the ref to be updated.
369Exiting with a non-zero status prevents <tt>git-receive-pack</tt>
370from updating the ref.</p>
371<p>This hook can be used to prevent <em>forced</em> update on certain refs by
Junio C Hamano1a4e8412005-12-27 08:17:23372making sure that the object name is a commit object that is a
373descendant of the commit object named by the old object name.
Junio C Hamano818f7d62006-03-26 01:49:30374That is, to enforce a "fast forward only" policy.</p>
375<p>It could also be used to log the old..new status. However, it
376does not know the entire set of branches, so it would end up
377firing one e-mail per ref when used naively, though.</p>
378<p>Another use suggested on the mailing list is to use this hook to
Junio C Hamano1a4e8412005-12-27 08:17:23379implement access control which is finer grained than the one
380based on filesystem group.</p>
Junio C Hamanod5784132006-09-20 21:29:27381<p>The standard output of this hook is sent to <tt>/dev/null</tt>; if you
382want to report something to the <tt>git-send-pack</tt> on the other end,
383you can redirect your output to your <tt>stderr</tt>.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23384</div>
385<h2>post-update</h2>
386<div class="sectionbody">
Junio C Hamano818f7d62006-03-26 01:49:30387<p>This hook is invoked by <tt>git-receive-pack</tt> on the remote repository,
Junio C Hamanod5784132006-09-20 21:29:27388which happens when a <tt>git push</tt> is done on a local repository.
Junio C Hamano818f7d62006-03-26 01:49:30389It executes on the remote repository once after all the refs have
390been updated.</p>
391<p>It takes a variable number of parameters, each of which is the
392name of ref that was actually updated.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23393<p>This hook is meant primarily for notification, and cannot affect
394the outcome of <tt>git-receive-pack</tt>.</p>
Junio C Hamanod5784132006-09-20 21:29:27395<p>The <em>post-update</em> hook can tell what are the heads that were pushed,
Junio C Hamano818f7d62006-03-26 01:49:30396but it does not know what their original and updated values are,
397so it is a poor place to do log old..new.</p>
Junio C Hamanod5784132006-09-20 21:29:27398<p>When enabled, the default <em>post-update</em> hook runs
Junio C Hamano1a4e8412005-12-27 08:17:23399<tt>git-update-server-info</tt> to keep the information used by dumb
Junio C Hamanod5784132006-09-20 21:29:27400transports (e.g., HTTP) up-to-date. If you are publishing
401a git repository that is accessible via HTTP, you should
Junio C Hamano818f7d62006-03-26 01:49:30402probably enable this hook.</p>
Junio C Hamanod5784132006-09-20 21:29:27403<p>The standard output of this hook is sent to <tt>/dev/null</tt>; if you
404want to report something to the <tt>git-send-pack</tt> on the other end,
405you can redirect your output to your <tt>stderr</tt>.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23406</div>
407<div id="footer">
408<div id="footer-text">
Junio C Hamanod5784132006-09-20 21:29:27409Last updated 20-Sep-2006 21:29:19 UTC
Junio C Hamano1a4e8412005-12-27 08:17:23410</div>
411</div>
412</body>
413</html>