diff options
| author | Junio C Hamano <gitster@pobox.com> | 2012-12-18 16:43:11 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2012-12-18 16:43:11 -0800 |
| commit | 9d9711544dc3090db6e5c52f9ce9c300bf4f5c14 (patch) | |
| tree | 23257b9801739fd96c9e82ef98a17500dce9f88e /githooks.html | |
| parent | 9629d4f49e5ffcff5c5beb5c40bedcffcabcd905 (diff) | |
| download | git-htmldocs-9d9711544dc3090db6e5c52f9ce9c300bf4f5c14.tar.gz | |
Autogenerated HTML docs for v1.8.1-rc2-5-g252f9
Diffstat (limited to 'githooks.html')
| -rw-r--r-- | githooks.html | 514 |
1 files changed, 358 insertions, 156 deletions
diff --git a/githooks.html b/githooks.html index 92b8a018a..5b9456e78 100644 --- a/githooks.html +++ b/githooks.html @@ -2,15 +2,25 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 8.5.2" />
+<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
+<meta name="generator" content="AsciiDoc 8.6.8" />
<title>githooks(5)</title>
<style type="text/css">
-/* Debug borders */
-p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
-/*
- border: 1px solid red;
-*/
+/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
+
+/* Default font. */
+body {
+ font-family: Georgia,serif;
+}
+
+/* Title font. */
+h1, h2, h3, h4, h5, h6,
+div.title, caption.title,
+thead, p.table.header,
+#toctitle,
+#author, #revnumber, #revdate, #revremark,
+#footer {
+ font-family: Arial,Helvetica,sans-serif;
}
body {
@@ -35,13 +45,8 @@ strong { color: #083194;
}
-tt {
- color: navy;
-}
-
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
- font-family: sans-serif;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
@@ -59,9 +64,11 @@ h3 { h3 + * {
clear: left;
}
+h5 {
+ font-size: 1.0em;
+}
div.sectionbody {
- font-family: serif;
margin-left: 0;
}
@@ -77,45 +84,48 @@ p { ul, ol, li > p {
margin-top: 0;
}
+ul > li { color: #aaa; }
+ul > li > * { color: black; }
-pre {
+.monospaced, code, pre {
+ font-family: "Courier New", Courier, monospace;
+ font-size: inherit;
+ color: navy;
padding: 0;
margin: 0;
}
-span#author {
+
+#author {
color: #527bbd;
- font-family: sans-serif;
font-weight: bold;
font-size: 1.1em;
}
-span#email {
+#email {
}
-span#revnumber, span#revdate, span#revremark {
- font-family: sans-serif;
+#revnumber, #revdate, #revremark {
}
-div#footer {
- font-family: sans-serif;
+#footer {
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
-div#footer-text {
+#footer-text {
float: left;
padding-bottom: 0.5em;
}
-div#footer-badges {
+#footer-badges {
float: right;
padding-bottom: 0.5em;
}
-div#preamble {
+#preamble {
margin-top: 1.5em;
margin-bottom: 1.5em;
}
-div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
+div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-top: 1.0em;
@@ -135,7 +145,6 @@ div.content { /* Block element content. */ /* Block element titles. */
div.title, caption.title {
color: #527bbd;
- font-family: sans-serif;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
@@ -157,13 +166,15 @@ div.content + div.title { div.sidebarblock > div.content {
background: #ffffee;
- border: 1px solid silver;
+ border: 1px solid #dddddd;
+ border-left: 4px solid #f0f0f0;
padding: 0.5em;
}
div.listingblock > div.content {
- border: 1px solid silver;
- background: #f4f4f4;
+ border: 1px solid #dddddd;
+ border-left: 5px solid #f0f0f0;
+ background: #f8f8f8;
padding: 0.5em;
}
@@ -171,8 +182,8 @@ div.quoteblock, div.verseblock { padding-left: 1.0em;
margin-left: 1.0em;
margin-right: 10%;
- border-left: 5px solid #dddddd;
- color: #777777;
+ border-left: 5px solid #f0f0f0;
+ color: #888;
}
div.quoteblock > div.attribution {
@@ -180,8 +191,9 @@ div.quoteblock > div.attribution { text-align: right;
}
-div.verseblock > div.content {
- white-space: pre;
+div.verseblock > pre.content {
+ font-family: inherit;
+ font-size: inherit;
}
div.verseblock > div.attribution {
padding-top: 0.75em;
@@ -254,35 +266,12 @@ div.compact div, div.compact div { margin-bottom: 0.1em;
}
-div.tableblock > table {
- border: 3px solid #527bbd;
-}
-thead, p.table.header {
- font-family: sans-serif;
- font-weight: bold;
-}
tfoot {
font-weight: bold;
}
td > div.verse {
white-space: pre;
}
-p.table {
- margin-top: 0;
-}
-/* Because the table frame attribute is overriden by CSS in most browsers. */
-div.tableblock > table[frame="void"] {
- border-style: none;
-}
-div.tableblock > table[frame="hsides"] {
- border-left-style: none;
- border-right-style: none;
-}
-div.tableblock > table[frame="vsides"] {
- border-top-style: none;
- border-bottom-style: none;
-}
-
div.hdlist {
margin-top: 0.8em;
@@ -339,25 +328,32 @@ span.footnote, span.footnoteref { min-width: 100px;
}
+div.colist td {
+ padding-right: 0.5em;
+ padding-bottom: 0.3em;
+ vertical-align: top;
+}
+div.colist td img {
+ margin-top: 0.3em;
+}
@media print {
- div#footer-badges { display: none; }
+ #footer-badges { display: none; }
}
-div#toc {
+#toc {
margin-bottom: 2.5em;
}
-div#toctitle {
+#toctitle {
color: #527bbd;
- font-family: sans-serif;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
-div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
+div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
@@ -373,69 +369,173 @@ div.toclevel4 { margin-left: 6em;
font-size: 0.9em;
}
-/* Overrides for manpage documents */
-h1 {
- padding-top: 0.5em;
- padding-bottom: 0.5em;
- border-top: 2px solid silver;
- border-bottom: 2px solid silver;
+
+span.aqua { color: aqua; }
+span.black { color: black; }
+span.blue { color: blue; }
+span.fuchsia { color: fuchsia; }
+span.gray { color: gray; }
+span.green { color: green; }
+span.lime { color: lime; }
+span.maroon { color: maroon; }
+span.navy { color: navy; }
+span.olive { color: olive; }
+span.purple { color: purple; }
+span.red { color: red; }
+span.silver { color: silver; }
+span.teal { color: teal; }
+span.white { color: white; }
+span.yellow { color: yellow; }
+
+span.aqua-background { background: aqua; }
+span.black-background { background: black; }
+span.blue-background { background: blue; }
+span.fuchsia-background { background: fuchsia; }
+span.gray-background { background: gray; }
+span.green-background { background: green; }
+span.lime-background { background: lime; }
+span.maroon-background { background: maroon; }
+span.navy-background { background: navy; }
+span.olive-background { background: olive; }
+span.purple-background { background: purple; }
+span.red-background { background: red; }
+span.silver-background { background: silver; }
+span.teal-background { background: teal; }
+span.white-background { background: white; }
+span.yellow-background { background: yellow; }
+
+span.big { font-size: 2em; }
+span.small { font-size: 0.6em; }
+
+span.underline { text-decoration: underline; }
+span.overline { text-decoration: overline; }
+span.line-through { text-decoration: line-through; }
+
+div.unbreakable { page-break-inside: avoid; }
+
+
+/*
+ * xhtml11 specific
+ *
+ * */
+
+div.tableblock {
+ margin-top: 1.0em;
+ margin-bottom: 1.5em;
}
-h2 {
+div.tableblock > table {
+ border: 3px solid #527bbd;
+}
+thead, p.table.header {
+ font-weight: bold;
+ color: #527bbd;
+}
+p.table {
+ margin-top: 0;
+}
+/* Because the table frame attribute is overriden by CSS in most browsers. */
+div.tableblock > table[frame="void"] {
border-style: none;
}
-div.sectionbody {
- margin-left: 5%;
+div.tableblock > table[frame="hsides"] {
+ border-left-style: none;
+ border-right-style: none;
}
-
-@media print {
- div#toc { display: none; }
+div.tableblock > table[frame="vsides"] {
+ border-top-style: none;
+ border-bottom-style: none;
}
-/* Workarounds for IE6's broken and incomplete CSS2. */
-div.sidebar-content {
- background: #ffffee;
- border: 1px solid silver;
- padding: 0.5em;
+/*
+ * html5 specific
+ *
+ * */
+
+table.tableblock {
+ margin-top: 1.0em;
+ margin-bottom: 1.5em;
}
-div.sidebar-title, div.image-title {
- color: #527bbd;
- font-family: sans-serif;
+thead, p.tableblock.header {
font-weight: bold;
- margin-top: 0.0em;
- margin-bottom: 0.5em;
+ color: #527bbd;
+}
+p.tableblock {
+ margin-top: 0;
+}
+table.tableblock {
+ border-width: 3px;
+ border-spacing: 0px;
+ border-style: solid;
+ border-color: #527bbd;
+ border-collapse: collapse;
+}
+th.tableblock, td.tableblock {
+ border-width: 1px;
+ padding: 4px;
+ border-style: solid;
+ border-color: #527bbd;
}
-div.listingblock div.content {
- border: 1px solid silver;
- background: #f4f4f4;
- padding: 0.5em;
+table.tableblock.frame-topbot {
+ border-left-style: hidden;
+ border-right-style: hidden;
+}
+table.tableblock.frame-sides {
+ border-top-style: hidden;
+ border-bottom-style: hidden;
+}
+table.tableblock.frame-none {
+ border-style: hidden;
}
-div.quoteblock-attribution {
- padding-top: 0.5em;
+th.tableblock.halign-left, td.tableblock.halign-left {
+ text-align: left;
+}
+th.tableblock.halign-center, td.tableblock.halign-center {
+ text-align: center;
+}
+th.tableblock.halign-right, td.tableblock.halign-right {
text-align: right;
}
-div.verseblock-content {
- white-space: pre;
+th.tableblock.valign-top, td.tableblock.valign-top {
+ vertical-align: top;
}
-div.verseblock-attribution {
- padding-top: 0.75em;
- text-align: left;
+th.tableblock.valign-middle, td.tableblock.valign-middle {
+ vertical-align: middle;
+}
+th.tableblock.valign-bottom, td.tableblock.valign-bottom {
+ vertical-align: bottom;
}
-div.exampleblock-content {
- border-left: 3px solid #dddddd;
- padding-left: 0.5em;
+
+/*
+ * manpage specific
+ *
+ * */
+
+body.manpage h1 {
+ padding-top: 0.5em;
+ padding-bottom: 0.5em;
+ border-top: 2px solid silver;
+ border-bottom: 2px solid silver;
+}
+body.manpage h2 {
+ border-style: none;
+}
+body.manpage div.sectionbody {
+ margin-left: 3em;
+}
+
+@media print {
+ body.manpage div#toc { display: none; }
}
-/* IE6 sets dynamically generated links as visited. */
-div#toc a:visited { color: blue; }
+
</style>
<script type="text/javascript">
/*<+'])');
+ var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
@@ -497,6 +597,25 @@ toc: function (toclevels) { }
var toc = document.getElementById("toc");
+ if (!toc) {
+ return;
+ }
+
+ // Delete existing TOC entries in case we're reloading the TOC.
+ var tocEntriesToRemove = [];
+ var i;
+ for (i = 0; i < toc.childNodes.length; i++) {
+ var entry = toc.childNodes[i];
+ if (entry.nodeName.toLowerCase() == 'div'
+ && entry.getAttribute("class")
+ && entry.getAttribute("class").match(/^toclevel/))
+ tocEntriesToRemove.push(entry);
+ }
+ for (i = 0; i < tocEntriesToRemove.length; i++) {
+ toc.removeChild(tocEntriesToRemove[i]);
+ }
+
+ // Rebuild TOC entries.
var entries = tocEntries(document.getElementById("content"), toclevels);
for (var i = 0; i < entries.length; ++i) {
var entry = entries[i];
@@ -524,24 +643,44 @@ toc: function (toclevels) { */
footnotes: function () {
- var cont = document.getElementById("content");
+ // Delete existing footnote entries in case we're reloading the footnodes.
+ var i;
var noteholder = document.getElementById("footnotes");
+ if (!noteholder) {
+ return;
+ }
+ var entriesToRemove = [];
+ for (i = 0; i < noteholder.childNodes.length; i++) {
+ var entry = noteholder.childNodes[i];
+ if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
+ entriesToRemove.push(entry);
+ }
+ for (i = 0; i < entriesToRemove.length; i++) {
+ noteholder.removeChild(entriesToRemove[i]);
+ }
+
+ // Rebuild footnote entries.
+ var cont = document.getElementById("content");
var spans = cont.getElementsByTagName("span");
var refs = {};
var n = 0;
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnote") {
n++;
- // Use [\s\S] in place of . so multi-line matches work.
- // Because JavaScript has no s (dotall) regex flag.
- note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
+ var note = spans[i].getAttribute("data-note");
+ if (!note) {
+ // Use [\s\S] in place of . so multi-line matches work.
+ // Because JavaScript has no s (dotall) regex flag.
+ note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
+ spans[i].innerHTML =
+ "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
+ "' title='View footnote' class='footnote'>" + n + "</a>]";
+ spans[i].setAttribute("data-note", note);
+ }
noteholder.innerHTML +=
"<div class='footnote' id='_footnote_" + n + "'>" +
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
n + "</a>. " + note + "</div>";
- spans[i].innerHTML =
- "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
- "' title='View footnote' class='footnote'>" + n + "</a>]";
var id =spans[i].getAttribute("id");
if (id != null) refs["#"+id] = n;
}
@@ -561,13 +700,36 @@ footnotes: function () { }
}
}
+},
+
+install: function(toclevels) {
+ var timerId;
+
+ function reinstall() {
+ asciidoc.footnotes();
+ if (toclevels) {
+ asciidoc.toc(toclevels);
+ }
+ }
+
+ function reinstallAndRemoveTimer() {
+ clearInterval(timerId);
+ reinstall();
+ }
+
+ timerId = setInterval(reinstall, 500);
+ if (document.addEventListener)
+ document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
+ else
+ window.onload = reinstallAndRemoveTimer;
}
}
+asciidoc.install();
/*]]>*/
</script>
</head>
-<body>
+<body class="manpage">
<div id="header">
<h1>
githooks(5) Manual Page
@@ -580,17 +742,20 @@ githooks(5) Manual Page </div>
</div>
<div id="content">
+<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="paragraph"><p>$GIT_DIR/hooks/*</p></div>
</div>
+</div>
+<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>Hooks are little scripts you can place in <tt>$GIT_DIR/hooks</tt>
+<div class="paragraph"><p>Hooks are little scripts you can place in <code>$GIT_DIR/hooks</code>
directory to trigger action at certain points. When
<em>git init</em> is run, a handful of example hooks are copied into the
-<tt>hooks</tt> directory of the new repository, but by default they are
-all disabled. To enable a hook, rename it by removing its <tt>.sample</tt>
+<code>hooks</code> directory of the new repository, but by default they are
+all disabled. To enable a hook, rename it by removing its <code>.sample</code>
suffix.</p></div>
<div class="admonitionblock">
<table><tr>
@@ -598,15 +763,18 @@ suffix.</p></div> <div class="title">Note</div>
</td>
<td class="content">It is also a requirement for a given hook to be executable.
-However - in a freshly initialized repository - the <tt>.sample</tt> files are
+However - in a freshly initialized repository - the <code>.sample</code> files are
executable by default.</td>
</tr></table>
</div>
<div class="paragraph"><p>This document describes the currently defined hooks.</p></div>
</div>
+</div>
+<div class="sect1">
<h2 id="_hooks">HOOKS</h2>
<div class="sectionbody">
-<h3 id="_applypatch_msg">applypatch-msg</h3><div style="clear:left"></div>
+<div class="sect2">
+<h3 id="_applypatch_msg">applypatch-msg</h3>
<div class="paragraph"><p>This hook is invoked by <em>git am</em> script. It takes a single
parameter, the name of the file that holds the proposed commit
log message. Exiting with non-zero status causes
@@ -617,7 +785,9 @@ format (if the project has one). It can also be used to refuse the commit after inspecting the message file.</p></div>
<div class="paragraph"><p>The default <em>applypatch-msg</em> hook, when enabled, runs the
<em>commit-msg</em> hook, if the latter is enabled.</p></div>
-<h3 id="_pre_applypatch">pre-applypatch</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="_pre_applypatch">pre-applypatch</h3>
<div class="paragraph"><p>This hook is invoked by <em>git am</em>. It takes no parameter, and is
invoked after the patch is applied, but before a commit is made.</p></div>
<div class="paragraph"><p>If it exits with non-zero status, then the working tree will not be
@@ -626,14 +796,18 @@ committed after applying the patch.</p></div> make a commit if it does not pass certain test.</p></div>
<div class="paragraph"><p>The default <em>pre-applypatch</em> hook, when enabled, runs the
<em>pre-commit</em> hook, if the latter is enabled.</p></div>
-<h3 id="_post_applypatch">post-applypatch</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="_post_applypatch">post-applypatch</h3>
<div class="paragraph"><p>This hook is invoked by <em>git am</em>. It takes no parameter,
and is invoked after the patch is applied and a commit is made.</p></div>
<div class="paragraph"><p>This hook is meant primarily for notification, and cannot affect
the outcome of <em>git am</em>.</p></div>
-<h3 id="_pre_commit">pre-commit</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="_pre_commit">pre-commit</h3>
<div class="paragraph"><p>This hook is invoked by <em>git commit</em>, and can be bypassed
-with <tt>--no-verify</tt> option. It takes no parameter, and is
+with <code>--no-verify</code> 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 <em>git commit</em> to abort.</p></div>
@@ -641,29 +815,33 @@ causes the <em>git commit</em> to abort.</p></div> of lines with trailing whitespaces and aborts the commit when
such a line is found.</p></div>
<div class="paragraph"><p>All the <em>git commit</em> hooks are invoked with the environment
-variable <tt>GIT_EDITOR=:</tt> if the command will not bring up an editor
+variable <code>GIT_EDITOR=:</code> if the command will not bring up an editor
to modify the commit message.</p></div>
-<h3 id="_prepare_commit_msg">prepare-commit-msg</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="_prepare_commit_msg">prepare-commit-msg</h3>
<div class="paragraph"><p>This hook is invoked by <em>git commit</em> right after preparing the
default log message, and before the editor is started.</p></div>
<div class="paragraph"><p>It takes one to three parameters. The first is the name of the file
that contains the commit log message. The second is the source of the commit
-message, and can be: <tt>message</tt> (if a <tt>-m</tt> or <tt>-F</tt> option was
-given); <tt>template</tt> (if a <tt>-t</tt> option was given or the
-configuration option <tt>commit.template</tt> is set); <tt>merge</tt> (if the
-commit is a merge or a <tt>.git/MERGE_MSG</tt> file exists); <tt>squash</tt>
-(if a <tt>.git/SQUASH_MSG</tt> file exists); or <tt>commit</tt>, followed by
-a commit SHA1 (if a <tt>-c</tt>, <tt>-C</tt> or <tt>--amend</tt> option was given).</p></div>
+message, and can be: <code>message</code> (if a <code>-m</code> or <code>-F</code> option was
+given); <code>template</code> (if a <code>-t</code> option was given or the
+configuration option <code>commit.template</code> is set); <code>merge</code> (if the
+commit is a merge or a <code>.git/MERGE_MSG</code> file exists); <code>squash</code>
+(if a <code>.git/SQUASH_MSG</code> file exists); or <code>commit</code>, followed by
+a commit SHA1 (if a <code>-c</code>, <code>-C</code> or <code>--amend</code> option was given).</p></div>
<div class="paragraph"><p>If the exit status is non-zero, <em>git commit</em> will abort.</p></div>
<div class="paragraph"><p>The purpose of the hook is to edit the message file in place, and
-it is not suppressed by the <tt>--no-verify</tt> option. A non-zero exit
+it is not suppressed by the <code>--no-verify</code> 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.</p></div>
-<div class="paragraph"><p>The sample <tt>prepare-commit-msg</tt> hook that comes with git comments
-out the <tt>Conflicts:</tt> part of a merge’s commit message.</p></div>
-<h3 id="_commit_msg">commit-msg</h3><div style="clear:left"></div>
+<div class="paragraph"><p>The sample <code>prepare-commit-msg</code> hook that comes with git comments
+out the <code>Conflicts:</code> part of a merge’s commit message.</p></div>
+</div>
+<div class="sect2">
+<h3 id="_commit_msg">commit-msg</h3>
<div class="paragraph"><p>This hook is invoked by <em>git commit</em>, and can be bypassed
-with <tt>--no-verify</tt> option. It takes a single parameter, the
+with <code>--no-verify</code> 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 <em>git commit</em> to
abort.</p></div>
@@ -673,15 +851,21 @@ format (if the project has one). It can also be used to refuse the commit after inspecting the message file.</p></div>
<div class="paragraph"><p>The default <em>commit-msg</em> hook, when enabled, detects duplicate
"Signed-off-by" lines, and aborts the commit if one is found.</p></div>
-<h3 id="_post_commit">post-commit</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="_post_commit">post-commit</h3>
<div class="paragraph"><p>This hook is invoked by <em>git commit</em>. It takes no
parameter, and is invoked after a commit is made.</p></div>
<div class="paragraph"><p>This hook is meant primarily for notification, and cannot affect
the outcome of <em>git commit</em>.</p></div>
-<h3 id="_pre_rebase">pre-rebase</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="_pre_rebase">pre-rebase</h3>
<div class="paragraph"><p>This hook is called by <em>git rebase</em> and can be used to prevent a branch
from getting rebased.</p></div>
-<h3 id="_post_checkout">post-checkout</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="_post_checkout">post-checkout</h3>
<div class="paragraph"><p>This hook is invoked when a <em>git checkout</em> 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
@@ -694,7 +878,9 @@ ref of the new HEAD and the flag is always 1.</p></div> <div class="paragraph"><p>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.</p></div>
-<h3 id="_post_merge">post-merge</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="_post_merge">post-merge</h3>
<div class="paragraph"><p>This hook is invoked by <em>git merge</em>, which happens when a <em>git pull</em>
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.
@@ -704,7 +890,9 @@ if the merge failed due to conflicts.</p></div> 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.</p></div>
-<h3 id="pre-receive">pre-receive</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="pre-receive">pre-receive</h3>
<div class="paragraph"><p>This hook is invoked by <em>git-receive-pack</em> on the remote repository,
which happens when a <em>git push</em> is done on a local repository.
Just before starting to update refs on the remote repository, the
@@ -715,19 +903,21 @@ arguments, but for each ref to be updated it receives on standard input a line of the format:</p></div>
<div class="literalblock">
<div class="content">
-<pre><tt><old-value> SP <new-value> SP <ref-name> LF</tt></pre>
+<pre><code><old-value> SP <new-value> SP <ref-name> LF</code></pre>
</div></div>
-<div class="paragraph"><p>where <tt><old-value></tt> is the old object name stored in the ref,
-<tt><new-value></tt> is the new object name to be stored in the ref and
-<tt><ref-name></tt> is the full name of the ref.
-When creating a new ref, <tt><old-value></tt> is 40 <tt>0</tt>.</p></div>
+<div class="paragraph"><p>where <code><old-value></code> is the old object name stored in the ref,
+<code><new-value></code> is the new object name to be stored in the ref and
+<code><ref-name></code> is the full name of the ref.
+When creating a new ref, <code><old-value></code> is 40 <code>0</code>.</p></div>
<div class="paragraph"><p>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 <a href="#update"><em>update</em></a> hook.</p></div>
<div class="paragraph"><p>Both standard output and standard error output are forwarded to
-<em>git send-pack</em> on the other end, so you can simply <tt>echo</tt> messages
+<em>git send-pack</em> on the other end, so you can simply <code>echo</code> messages
for the user.</p></div>
-<h3 id="update">update</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="update">update</h3>
<div class="paragraph"><p>This hook is invoked by <em>git-receive-pack</em> on the remote repository,
which happens when a <em>git push</em> is done on a local repository.
Just before updating the ref on the remote repository, the update hook
@@ -767,12 +957,14 @@ firing one e-mail per ref when used naively, though. The implement access control which is finer grained than the one
based on filesystem group.</p></div>
<div class="paragraph"><p>Both standard output and standard error output are forwarded to
-<em>git send-pack</em> on the other end, so you can simply <tt>echo</tt> messages
+<em>git send-pack</em> on the other end, so you can simply <code>echo</code> messages
for the user.</p></div>
<div class="paragraph"><p>The default <em>update</em> hook, when enabled—and with
-<tt>hooks.allowunannotated</tt> config option unset or set to false—prevents
+<code>hooks.allowunannotated</code> config option unset or set to false—prevents
unannotated tags to be pushed.</p></div>
-<h3 id="post-receive">post-receive</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="post-receive">post-receive</h3>
<div class="paragraph"><p>This hook is invoked by <em>git-receive-pack</em> on the remote repository,
which happens when a <em>git push</em> is done on a local repository.
It executes on the remote repository once after all the refs have
@@ -787,13 +979,15 @@ is called after the real work is done.</p></div> both old and new values of all the refs in addition to their
names.</p></div>
<div class="paragraph"><p>Both standard output and standard error output are forwarded to
-<em>git send-pack</em> on the other end, so you can simply <tt>echo</tt> messages
+<em>git send-pack</em> on the other end, so you can simply <code>echo</code> messages
for the user.</p></div>
<div class="paragraph"><p>The default <em>post-receive</em> hook is empty, but there is
-a sample script <tt>post-receive-email</tt> provided in the <tt>contrib/hooks</tt>
+a sample script <code>post-receive-email</code> provided in the <code>contrib/hooks</code>
directory in git distribution, which implements sending commit
emails.</p></div>
-<h3 id="post-update">post-update</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="post-update">post-update</h3>
<div class="paragraph"><p>This hook is invoked by <em>git-receive-pack</em> on the remote repository,
which happens when a <em>git push</em> is done on a local repository.
It executes on the remote repository once after all the refs have
@@ -814,23 +1008,27 @@ 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.</p></div>
<div class="paragraph"><p>Both standard output and standard error output are forwarded to
-<em>git send-pack</em> on the other end, so you can simply <tt>echo</tt> messages
+<em>git send-pack</em> on the other end, so you can simply <code>echo</code> messages
for the user.</p></div>
-<h3 id="_pre_auto_gc">pre-auto-gc</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="_pre_auto_gc">pre-auto-gc</h3>
<div class="paragraph"><p>This hook is invoked by <em>git gc --auto</em>. It takes no parameter, and
exiting with non-zero status from this script causes the <em>git gc --auto</em>
to abort.</p></div>
-<h3 id="_post_rewrite">post-rewrite</h3><div style="clear:left"></div>
-<div class="paragraph"><p>This hook is invoked by commands that rewrite commits (<tt>git commit
---amend</tt>, <em>git-rebase</em>; currently <em>git-filter-branch</em> does <em>not</em> call
+</div>
+<div class="sect2">
+<h3 id="_post_rewrite">post-rewrite</h3>
+<div class="paragraph"><p>This hook is invoked by commands that rewrite commits (<code>git commit
+--amend</code>, <em>git-rebase</em>; currently <em>git-filter-branch</em> does <em>not</em> call
it!). Its first argument denotes the command it was invoked by:
-currently one of <tt>amend</tt> or <tt>rebase</tt>. Further command-dependent
+currently one of <code>amend</code> or <code>rebase</code>. Further command-dependent
arguments may be passed in the future.</p></div>
<div class="paragraph"><p>The hook receives a list of the rewritten commits on stdin, in the
format</p></div>
<div class="literalblock">
<div class="content">
-<pre><tt><old-sha1> SP <new-sha1> [ SP <extra-info> ] LF</tt></pre>
+<pre><code><old-sha1> SP <new-sha1> [ SP <extra-info> ] LF</code></pre>
</div></div>
<div class="paragraph"><p>The <em>extra-info</em> is again command-dependent. If it is empty, the
preceding SP is also omitted. Currently, no commands pass any
@@ -855,11 +1053,15 @@ processed by rebase.</p></div> </dd>
</dl></div>
</div>
+</div>
+</div>
+<div class="sect1">
<h2 id="_git">GIT</h2>
<div class="sectionbody">
<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
</div>
</div>
+</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
|