Autogenerated HTML docs for v1.5.5.1-248-g4b17
authorJunio C Hamano <junio@hera.kernel.org>
Wed, 14 May 2008 22:26:07 +0000 (22:26 +0000)
committerJunio C Hamano <junio@hera.kernel.org>
Wed, 14 May 2008 22:26:07 +0000 (22:26 +0000)
23 files changed:
cvs-migration.html
cvs-migration.txt
git-commit.html
git-commit.txt
git-config.html
git-describe.html
git-describe.txt
git-format-patch.html
git-format-patch.txt
git-merge.html
git-rev-parse.html
git-rev-parse.txt
git.html
git.txt
gitcli.html
gitcli.txt
githooks.html [new file with mode: 0644]
githooks.txt [moved from hooks.txt with 98% similarity]
merge-config.txt
repository-layout.html
repository-layout.txt
user-manual.html
user-manual.txt

index 69224bb549692fb1bafa91be41b9c89f10641ca8..93ab28500ea31532750c2b6f7de1ac5975fbd87c 100644 (file)
@@ -386,7 +386,7 @@ necessary.</p>
 <div class="sectionbody">\r
 <p>Git allows you to specify scripts called "hooks" to be run at certain\r
 points.  You can use these, for example, to send all commits to the shared\r
-repository to a mailing list.  See <a href="hooks.html">Hooks used by git</a>.</p>\r
+repository to a mailing list.  See <a href="githooks.html">githooks(5)</a>[Hooks used by git].</p>\r
 <p>You can enforce finer grained permissions using update hooks.  See\r
 <a href="howto/update-hook-example.txt">Controlling access to branches using\r
 update hooks</a>.</p>\r
@@ -417,7 +417,7 @@ repositories without the need for a central maintainer.</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 26-Apr-2008 02:23:17 UTC\r
+Last updated 14-May-2008 22:24:44 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 00f2e36b2ec162c6ef6d9c731ff549643ecb3ce7..374bc87b105dfb04003f1aa3c0b1e2a8ea7ac805 100644 (file)
@@ -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
index 0b1c56969f4b13a94d6ff33b5519f387848fd6dd..19da70110a69c1627b89317ff408cd623e0bb6a8 100644 (file)
@@ -405,7 +405,7 @@ that, you can recover from it with <a href="git-reset.html">git-reset(1)</a>.</p
 <dd>\r
 <p>\r
         This option bypasses the pre-commit and commit-msg hooks.\r
-        See also <a href="hooks.html">hooks</a>.\r
+        See also <a href="githooks.html">githooks(5)</a>[hooks].\r
 </p>\r
 </dd>\r
 <dt>\r
@@ -724,7 +724,7 @@ order).</p>
 <h2>HOOKS</h2>\r
 <div class="sectionbody">\r
 <p>This command can run <tt>commit-msg</tt>, <tt>prepare-commit-msg</tt>, <tt>pre-commit</tt>,\r
-and <tt>post-commit</tt> hooks.  See <a href="hooks.html">hooks</a> for more\r
+and <tt>post-commit</tt> hooks.  See <a href="githooks.html">githooks(5)</a>[hooks] for more\r
 information.</p>\r
 </div>\r
 <h2>SEE ALSO</h2>\r
@@ -746,7 +746,7 @@ Junio C Hamano &lt;junkio@cox.net&gt;</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 12-Apr-2008 08:22:49 UTC\r
+Last updated 14-May-2008 22:24:40 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 4bb51cc06ec5e1f47b748b14353e49a0acfdc775..c3c9f5b9021e60f815d41a0454b0238865251175 100644 (file)
@@ -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.
 
 
index a6db05dd4e46bf98acc7841a4abd2f18d16f9a9e..31c130070f8399b382d6b03d87e58ac09dc6b125 100644 (file)
@@ -2032,6 +2032,16 @@ merge.log
 </p>\r
 </dd>\r
 <dt>\r
+merge.renameLimit\r
+</dt>\r
+<dd>\r
+<p>\r
+        The number of files to consider when performing rename detection\r
+        during a merge; if not specified, defaults to the value of\r
+        diff.renameLimit.\r
+</p>\r
+</dd>\r
+<dt>\r
 merge.tool\r
 </dt>\r
 <dd>\r
@@ -2551,7 +2561,7 @@ web.browser
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 12-May-2008 00:29:20 UTC\r
+Last updated 14-May-2008 22:24:40 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 94d633db8973a81cd4fde0e3da98ad02143bac22..b3b23973ba8eb2fb117aaa18557425dbb735b35a 100644 (file)
@@ -277,9 +277,10 @@ git-describe(1) Manual Page
 <h2>DESCRIPTION</h2>\r
 <div class="sectionbody">\r
 <p>The command finds the most recent tag that is reachable from a\r
-commit, and if the commit itself is pointed at by the tag, shows\r
-the tag.  Otherwise, it suffixes the tag name with the number of\r
-additional commits and the abbreviated object name of the commit.</p>\r
+commit.  If the tag points to the commit, then only the tag is\r
+shown.  Otherwise, it suffixes the tag name with the number of\r
+additional commits on top of the tagged object and the\r
+abbreviated object name of the most recent commit.</p>\r
 </div>\r
 <h2>OPTIONS</h2>\r
 <div class="sectionbody">\r
@@ -461,7 +462,7 @@ updated by Shawn Pearce &lt;spearce@spearce.org&gt;.</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 03-Mar-2008 01:59:56 UTC\r
+Last updated 14-May-2008 22:24:41 UTC\r
 </div>\r
 </div>\r
 </body>\r
index d9aa2f29809eb07385468edd2587daf55339389a..69e1ab750d99defc98f671317ae6ae65debd92b0 100644 (file)
@@ -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
index 844ec36ef54a3f756c9bece50617475d91e96dab..53b50d53256bdc1d37b5fcb76085400849076a94 100644 (file)
@@ -998,7 +998,8 @@ and file suffix, and number patches when outputting more than one.</p>
         headers = "Organization: git-foo\n"\r
         subjectprefix = CHANGE\r
         suffix = .txt\r
-        numbered = auto</tt></pre>\r
+        numbered = auto\r
+        cc = &lt;email&gt;</tt></pre>\r
 </div></div>\r
 </div>\r
 <h2>EXAMPLES</h2>\r
@@ -1079,7 +1080,7 @@ as e-mailable patches:
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 12-May-2008 00:29:20 UTC\r
+Last updated 14-May-2008 22:24:41 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 7548a21d352f0625a114f48c3063612f2a063436..c60ce123ec745e1903da0b5ab50e4efabeeb5dc3 100644 (file)
@@ -174,6 +174,7 @@ and file suffix, and number patches when outputting more than one.
         subjectprefix = CHANGE
         suffix = .txt
         numbered = auto
+       cc = <email>
 ------------
 
 
index e166586d5aa6ff7b915bc39e0ed7b5c263c5f788..02a154c0060202f2ba4544917f0fd0e998e16652 100644 (file)
@@ -523,6 +523,16 @@ merge.log
 </p>\r
 </dd>\r
 <dt>\r
+merge.renameLimit\r
+</dt>\r
+<dd>\r
+<p>\r
+        The number of files to consider when performing rename detection\r
+        during a merge; if not specified, defaults to the value of\r
+        diff.renameLimit.\r
+</p>\r
+</dd>\r
+<dt>\r
 merge.tool\r
 </dt>\r
 <dd>\r
@@ -739,7 +749,7 @@ Resolve the conflicts.  <tt>git-diff</tt> would report only the
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 09-May-2008 05:45:38 UTC\r
+Last updated 14-May-2008 22:24:42 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 785ccf1ab3c1c0e10882fb9f1c731a90260d1a20..b3f7a956b4bf9c1607a19493a6b69a187aa84879 100644 (file)
@@ -816,7 +816,7 @@ Use <tt>?</tt> to mean that the option is optional (though its use is discourage
 <p>\r
 Use <tt>*</tt> to mean that this option should not be listed in the usage\r
           generated for the <tt>-h</tt> argument. It's shown for <tt>--help-all</tt> as\r
-          documented in <a href="gitcli.html">gitcli(5)</a>.\r
+          documented in <a href="gitcli.html">gitcli(7)</a>.\r
 </p>\r
 </li>\r
 <li>\r
@@ -866,7 +866,7 @@ Junio C Hamano &lt;junkio@cox.net&gt; and Pierre Habouzit &lt;madcoder@debian.or
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 28-Apr-2008 08:40:12 UTC\r
+Last updated 14-May-2008 22:24:42 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 110e7ba71f48c54cb94f35e819583826e123a8b1..b6b2fe92a15bcb3ea314e5411e957e41e67904d8 100644 (file)
@@ -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.
 
index f02fdf01b02606a50d52af58906149661271956d..ea7673a37cb400fc81de47f2bc29b642d78362c9 100644 (file)
--- a/git.html
+++ b/git.html
@@ -1629,7 +1629,7 @@ HEAD
 <h2>File/Directory Structure</h2>\r
 <div class="sectionbody">\r
 <p>Please see the <a href="repository-layout.html">repository layout</a> document.</p>\r
-<p>Read <a href="hooks.html">hooks</a> for more details about each hook.</p>\r
+<p>Read <a href="githooks.html">githooks(5)</a>[hooks] for more details about each hook.</p>\r
 <p>Higher level SCMs may provide and manage additional information in the\r
 <tt>$GIT_DIR</tt>.</p>\r
 </div>\r
@@ -1952,7 +1952,7 @@ contributors on the git-list &lt;git@vger.kernel.org&gt;.</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 30-Apr-2008 08:42:10 UTC\r
+Last updated 14-May-2008 22:24:43 UTC\r
 </div>\r
 </div>\r
 </body>\r
diff --git a/git.txt b/git.txt
index 6f445b1e3bbefccdb865f8cb93fb470892b94e41..adcd3e00b201af6182bbc441aa0b288a5d2db8a5 100644 (file)
--- 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`.
index 743d6ab92efdb0f2e592682dc150b3cb5b83c0de..cd49a6909f8738e6a58d98ca5320cf6d3189b911 100644 (file)
@@ -256,12 +256,12 @@ div.exampleblock-content {
   padding-left: 0.5em;\r
 }\r
 </style>\r
-<title>gitcli(5)</title>\r
+<title>gitcli(7)</title>\r
 </head>\r
 <body>\r
 <div id="header">\r
 <h1>\r
-gitcli(5) Manual Page\r
+gitcli(7) Manual Page\r
 </h1>\r
 <h2>NAME</h2>\r
 <div class="sectionbody">\r
@@ -388,7 +388,7 @@ $ git describe --abbrev 10 HEAD  # NOT WHAT YOU MEANT</tt></pre>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 08-Jan-2008 09:12:44 UTC\r
+Last updated 14-May-2008 22:24:43 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 7ee5ce386f851ee054991c5275d89bca4f226447..835cb05f9655de943b7b65178c933fc5d39c52f8 100644 (file)
@@ -1,4 +1,4 @@
-gitcli(5)
+gitcli(7)
 =========
 
 NAME
diff --git a/githooks.html b/githooks.html
new file mode 100644 (file)
index 0000000..2c03526
--- /dev/null
@@ -0,0 +1,532 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
+    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
+<head>\r
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
+<meta name="generator" content="AsciiDoc 7.0.2" />\r
+<style type="text/css">\r
+/* Debug borders */\r
+p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
+/*\r
+  border: 1px solid red;\r
+*/\r
+}\r
+\r
+body {\r
+  margin: 1em 5% 1em 5%;\r
+}\r
+\r
+a { color: blue; }\r
+a:visited { color: fuchsia; }\r
+\r
+em {\r
+  font-style: italic;\r
+}\r
+\r
+strong {\r
+  font-weight: bold;\r
+}\r
+\r
+tt {\r
+  color: navy;\r
+}\r
+\r
+h1, h2, h3, h4, h5, h6 {\r
+  color: #527bbd;\r
+  font-family: sans-serif;\r
+  margin-top: 1.2em;\r
+  margin-bottom: 0.5em;\r
+  line-height: 1.3;\r
+}\r
+\r
+h1 {\r
+  border-bottom: 2px solid silver;\r
+}\r
+h2 {\r
+  border-bottom: 2px solid silver;\r
+  padding-top: 0.5em;\r
+}\r
+\r
+div.sectionbody {\r
+  font-family: serif;\r
+  margin-left: 0;\r
+}\r
+\r
+hr {\r
+  border: 1px solid silver;\r
+}\r
+\r
+p {\r
+  margin-top: 0.5em;\r
+  margin-bottom: 0.5em;\r
+}\r
+\r
+pre {\r
+  padding: 0;\r
+  margin: 0;\r
+}\r
+\r
+span#author {\r
+  color: #527bbd;\r
+  font-family: sans-serif;\r
+  font-weight: bold;\r
+  font-size: 1.2em;\r
+}\r
+span#email {\r
+}\r
+span#revision {\r
+  font-family: sans-serif;\r
+}\r
+\r
+div#footer {\r
+  font-family: sans-serif;\r
+  font-size: small;\r
+  border-top: 2px solid silver;\r
+  padding-top: 0.5em;\r
+  margin-top: 4.0em;\r
+}\r
+div#footer-text {\r
+  float: left;\r
+  padding-bottom: 0.5em;\r
+}\r
+div#footer-badges {\r
+  float: right;\r
+  padding-bottom: 0.5em;\r
+}\r
+\r
+div#preamble,\r
+div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
+div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
+div.admonitionblock {\r
+  margin-right: 10%;\r
+  margin-top: 1.5em;\r
+  margin-bottom: 1.5em;\r
+}\r
+div.admonitionblock {\r
+  margin-top: 2.5em;\r
+  margin-bottom: 2.5em;\r
+}\r
+\r
+div.content { /* Block element content. */\r
+  padding: 0;\r
+}\r
+\r
+/* Block element titles. */\r
+div.title, caption.title {\r
+  font-family: sans-serif;\r
+  font-weight: bold;\r
+  text-align: left;\r
+  margin-top: 1.0em;\r
+  margin-bottom: 0.5em;\r
+}\r
+div.title + * {\r
+  margin-top: 0;\r
+}\r
+\r
+td div.title:first-child {\r
+  margin-top: 0.0em;\r
+}\r
+div.content div.title:first-child {\r
+  margin-top: 0.0em;\r
+}\r
+div.content + div.title {\r
+  margin-top: 0.0em;\r
+}\r
+\r
+div.sidebarblock > div.content {\r
+  background: #ffffee;\r
+  border: 1px solid silver;\r
+  padding: 0.5em;\r
+}\r
+\r
+div.listingblock > div.content {\r
+  border: 1px solid silver;\r
+  background: #f4f4f4;\r
+  padding: 0.5em;\r
+}\r
+\r
+div.quoteblock > div.content {\r
+  padding-left: 2.0em;\r
+}\r
+div.quoteblock .attribution {\r
+  text-align: right;\r
+}\r
+\r
+div.admonitionblock .icon {\r
+  vertical-align: top;\r
+  font-size: 1.1em;\r
+  font-weight: bold;\r
+  text-decoration: underline;\r
+  color: #527bbd;\r
+  padding-right: 0.5em;\r
+}\r
+div.admonitionblock td.content {\r
+  padding-left: 0.5em;\r
+  border-left: 2px solid silver;\r
+}\r
+\r
+div.exampleblock > div.content {\r
+  border-left: 2px solid silver;\r
+  padding: 0.5em;\r
+}\r
+\r
+div.verseblock div.content {\r
+  white-space: pre;\r
+}\r
+\r
+div.imageblock div.content { padding-left: 0; }\r
+div.imageblock img { border: 1px solid silver; }\r
+span.image img { border-style: none; }\r
+\r
+dl {\r
+  margin-top: 0.8em;\r
+  margin-bottom: 0.8em;\r
+}\r
+dt {\r
+  margin-top: 0.5em;\r
+  margin-bottom: 0;\r
+  font-style: italic;\r
+}\r
+dd > *:first-child {\r
+  margin-top: 0;\r
+}\r
+\r
+ul, ol {\r
+    list-style-position: outside;\r
+}\r
+ol.olist2 {\r
+  list-style-type: lower-alpha;\r
+}\r
+\r
+div.tableblock > table {\r
+  border-color: #527bbd;\r
+  border-width: 3px;\r
+}\r
+thead {\r
+  font-family: sans-serif;\r
+  font-weight: bold;\r
+}\r
+tfoot {\r
+  font-weight: bold;\r
+}\r
+\r
+div.hlist {\r
+  margin-top: 0.8em;\r
+  margin-bottom: 0.8em;\r
+}\r
+td.hlist1 {\r
+  vertical-align: top;\r
+  font-style: italic;\r
+  padding-right: 0.8em;\r
+}\r
+td.hlist2 {\r
+  vertical-align: top;\r
+}\r
+\r
+@media print {\r
+  div#footer-badges { display: none; }\r
+}\r
+include::./stylesheets/xhtml11-manpage.css[]\r
+/* Workarounds for IE6's broken and incomplete CSS2. */\r
+\r
+div.sidebar-content {\r
+  background: #ffffee;\r
+  border: 1px solid silver;\r
+  padding: 0.5em;\r
+}\r
+div.sidebar-title, div.image-title {\r
+  font-family: sans-serif;\r
+  font-weight: bold;\r
+  margin-top: 0.0em;\r
+  margin-bottom: 0.5em;\r
+}\r
+\r
+div.listingblock div.content {\r
+  border: 1px solid silver;\r
+  background: #f4f4f4;\r
+  padding: 0.5em;\r
+}\r
+\r
+div.quoteblock-content {\r
+  padding-left: 2.0em;\r
+}\r
+\r
+div.exampleblock-content {\r
+  border-left: 2px solid silver;\r
+  padding-left: 0.5em;\r
+}\r
+</style>\r
+<title>githooks(5)</title>\r
+</head>\r
+<body>\r
+<div id="header">\r
+<h1>\r
+githooks(5) Manual Page\r
+</h1>\r
+<h2>NAME</h2>\r
+<div class="sectionbody">\r
+<p>githooks -\r
+   Hooks used by git\r
+</p>\r
+</div>\r
+</div>\r
+<h2>SYNOPSIS</h2>\r
+<div class="sectionbody">\r
+<p>$GIT_DIR/hooks/*</p>\r
+</div>\r
+<h2>DESCRIPTION</h2>\r
+<div class="sectionbody">\r
+<p>Hooks are little scripts you can place in <tt>$GIT_DIR/hooks</tt>\r
+directory to trigger action at certain points.  When\r
+<tt>git-init</tt> is run, a handful example hooks are copied in the\r
+<tt>hooks</tt> directory of the new repository, but by default they are\r
+all disabled.  To enable a hook, make it executable with <tt>chmod +x</tt>.</p>\r
+<p>This document describes the currently defined hooks.</p>\r
+</div>\r
+<h2>applypatch-msg</h2>\r
+<div class="sectionbody">\r
+<p>This hook is invoked by <tt>git-am</tt> script.  It takes a single\r
+parameter, the name of the file that holds the proposed commit\r
+log message.  Exiting with non-zero status causes\r
+<tt>git-am</tt> to abort before applying the patch.</p>\r
+<p>The hook is allowed to edit the message file in place, and can\r
+be used to normalize the message into some project standard\r
+format (if the project has one). It can also be used to refuse\r
+the commit after inspecting the message file.</p>\r
+<p>The default <em>applypatch-msg</em> hook, when enabled, runs the\r
+<em>commit-msg</em> hook, if the latter is enabled.</p>\r
+</div>\r
+<h2>pre-applypatch</h2>\r
+<div class="sectionbody">\r
+<p>This hook is invoked by <tt>git-am</tt>.  It takes no parameter, and is\r
+invoked after the patch is applied, but before a commit is made.</p>\r
+<p>If it exits with non-zero status, then the working tree will not be\r
+committed after applying the patch.</p>\r
+<p>It can be used to inspect the current working tree and refuse to\r
+make a commit if it does not pass certain test.</p>\r
+<p>The default <em>pre-applypatch</em> hook, when enabled, runs the\r
+<em>pre-commit</em> hook, if the latter is enabled.</p>\r
+</div>\r
+<h2>post-applypatch</h2>\r
+<div class="sectionbody">\r
+<p>This hook is invoked by <tt>git-am</tt>.  It takes no parameter,\r
+and is invoked after the patch is applied and a commit is made.</p>\r
+<p>This hook is meant primarily for notification, and cannot affect\r
+the outcome of <tt>git-am</tt>.</p>\r
+</div>\r
+<h2>pre-commit</h2>\r
+<div class="sectionbody">\r
+<p>This hook is invoked by <tt>git-commit</tt>, and can be bypassed\r
+with <tt>--no-verify</tt> option.  It takes no parameter, and is\r
+invoked before obtaining the proposed commit log message and\r
+making a commit.  Exiting with non-zero status from this script\r
+causes the <tt>git-commit</tt> to abort.</p>\r
+<p>The default <em>pre-commit</em> hook, when enabled, catches introduction\r
+of lines with trailing whitespaces and aborts the commit when\r
+such a line is found.</p>\r
+<p>All the <tt>git-commit</tt> hooks are invoked with the environment\r
+variable <tt>GIT_EDITOR=:</tt> if the command will not bring up an editor\r
+to modify the commit message.</p>\r
+</div>\r
+<h2>prepare-commit-msg</h2>\r
+<div class="sectionbody">\r
+<p>This hook is invoked by <tt>git-commit</tt> right after preparing the\r
+default log message, and before the editor is started.</p>\r
+<p>It takes one to three parameters.  The first is the name of the file\r
+that the commit log message.  The second is the source of the commit\r
+message, and can be: <tt>message</tt> (if a <tt>\-m</tt> or <tt>\-F</tt> option was\r
+given); <tt>template</tt> (if a <tt>\-t</tt> option was given or the\r
+configuration option <tt>commit.template</tt> is set); <tt>merge</tt> (if the\r
+commit is a merge or a <tt>.git/MERGE_MSG</tt> file exists); <tt>squash</tt>\r
+(if a <tt>.git/SQUASH_MSG</tt> file exists); or <tt>commit</tt>, followed by\r
+a commit SHA1 (if a <tt>\-c</tt>, <tt>\-C</tt> or <tt>--amend</tt> option was given).</p>\r
+<p>If the exit status is non-zero, <tt>git-commit</tt> will abort.</p>\r
+<p>The purpose of the hook is to edit the message file in place, and\r
+it is not suppressed by the <tt>--no-verify</tt> option.  A non-zero exit\r
+means a failure of the hook and aborts the commit.  It should not\r
+be used as replacement for pre-commit hook.</p>\r
+<p>The sample <tt>prepare-commit-msg</tt> hook that comes with git comments\r
+out the <tt>Conflicts:</tt> part of a merge's commit message.</p>\r
+</div>\r
+<h2>commit-msg</h2>\r
+<div class="sectionbody">\r
+<p>This hook is invoked by <tt>git-commit</tt>, and can be bypassed\r
+with <tt>--no-verify</tt> option.  It takes a single parameter, the\r
+name of the file that holds the proposed commit log message.\r
+Exiting with non-zero status causes the <tt>git-commit</tt> to\r
+abort.</p>\r
+<p>The hook is allowed to edit the message file in place, and can\r
+be used to normalize the message into some project standard\r
+format (if the project has one). It can also be used to refuse\r
+the commit after inspecting the message file.</p>\r
+<p>The default <em>commit-msg</em> hook, when enabled, detects duplicate\r
+"Signed-off-by" lines, and aborts the commit if one is found.</p>\r
+</div>\r
+<h2>post-commit</h2>\r
+<div class="sectionbody">\r
+<p>This hook is invoked by <tt>git-commit</tt>.  It takes no\r
+parameter, and is invoked after a commit is made.</p>\r
+<p>This hook is meant primarily for notification, and cannot affect\r
+the outcome of <tt>git-commit</tt>.</p>\r
+</div>\r
+<h2>post-checkout</h2>\r
+<div class="sectionbody">\r
+<p>This hook is invoked when a <tt>git-checkout</tt> is run after having updated the\r
+worktree.  The hook is given three parameters: the ref of the previous HEAD,\r
+the ref of the new HEAD (which may or may not have changed), and a flag\r
+indicating whether the checkout was a branch checkout (changing branches,\r
+flag=1) or a file checkout (retrieving a file from the index, flag=0).\r
+This hook cannot affect the outcome of <tt>git-checkout</tt>.</p>\r
+<p>This hook can be used to perform repository validity checks, auto-display\r
+differences from the previous HEAD if different, or set working dir metadata\r
+properties.</p>\r
+</div>\r
+<h2>post-merge</h2>\r
+<div class="sectionbody">\r
+<p>This hook is invoked by <tt>git-merge</tt>, which happens when a <tt>git pull</tt>\r
+is done on a local repository.  The hook takes a single parameter, a status\r
+flag specifying whether or not the merge being done was a squash merge.\r
+This hook cannot affect the outcome of <tt>git-merge</tt> and is not executed,\r
+if the merge failed due to conflicts.</p>\r
+<p>This hook can be used in conjunction with a corresponding pre-commit hook to\r
+save and restore any form of metadata associated with the working tree\r
+(eg: permissions/ownership, ACLS, etc).  See contrib/hooks/setgitperms.perl\r
+for an example of how to do this.</p>\r
+</div>\r
+<h2><a id="pre-receive"></a>pre-receive</h2>\r
+<div class="sectionbody">\r
+<p>This hook is invoked by <tt>git-receive-pack</tt> on the remote repository,\r
+which happens when a <tt>git push</tt> is done on a local repository.\r
+Just before starting to update refs on the remote repository, the\r
+pre-receive hook is invoked.  Its exit status determines the success\r
+or failure of the update.</p>\r
+<p>This hook executes once for the receive operation. It takes no\r
+arguments, but for each ref to be updated it receives on standard\r
+input a line of the format:</p>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>&lt;old-value&gt; SP &lt;new-value&gt; SP &lt;ref-name&gt; LF</tt></pre>\r
+</div></div>\r
+<p>where <tt>&lt;old-value&gt;</tt> is the old object name stored in the ref,\r
+<tt>&lt;new-value&gt;</tt> is the new object name to be stored in the ref and\r
+<tt>&lt;ref-name&gt;</tt> is the full name of the ref.\r
+When creating a new ref, <tt>&lt;old-value&gt;</tt> is 40 <tt>0</tt>.</p>\r
+<p>If the hook exits with non-zero status, none of the refs will be\r
+updated. If the hook exits with zero, updating of individual refs can\r
+still be prevented by the <a href="#update"><em>update</em></a> hook.</p>\r
+<p>Both standard output and standard error output are forwarded to\r
+<tt>git-send-pack</tt> on the other end, so you can simply <tt>echo</tt> messages\r
+for the user.</p>\r
+</div>\r
+<h2><a id="update"></a>update</h2>\r
+<div class="sectionbody">\r
+<p>This hook is invoked by <tt>git-receive-pack</tt> on the remote repository,\r
+which happens when a <tt>git push</tt> is done on a local repository.\r
+Just before updating the ref on the remote repository, the update hook\r
+is invoked.  Its exit status determines the success or failure of\r
+the ref update.</p>\r
+<p>The hook executes once for each ref to be updated, and takes\r
+three parameters:</p>\r
+<ul>\r
+<li>\r
+<p>\r
+the name of the ref being updated,\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+the old object name stored in the ref,\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+and the new objectname to be stored in the ref.\r
+</p>\r
+</li>\r
+</ul>\r
+<p>A zero exit from the update hook allows the ref to be updated.\r
+Exiting with a non-zero status prevents <tt>git-receive-pack</tt>\r
+from updating that ref.</p>\r
+<p>This hook can be used to prevent <em>forced</em> update on certain refs by\r
+making sure that the object name is a commit object that is a\r
+descendant of the commit object named by the old object name.\r
+That is, to enforce a "fast forward only" policy.</p>\r
+<p>It could also be used to log the old..new status.  However, it\r
+does not know the entire set of branches, so it would end up\r
+firing one e-mail per ref when used naively, though.  The\r
+<a href="#post-receive"><em>post-receive</em></a> hook is more suited to that.</p>\r
+<p>Another use suggested on the mailing list is to use this hook to\r
+implement access control which is finer grained than the one\r
+based on filesystem group.</p>\r
+<p>Both standard output and standard error output are forwarded to\r
+<tt>git-send-pack</tt> on the other end, so you can simply <tt>echo</tt> messages\r
+for the user.</p>\r
+<p>The default <em>update</em> hook, when enabled--and with\r
+<tt>hooks.allowunannotated</tt> config option turned on--prevents\r
+unannotated tags to be pushed.</p>\r
+</div>\r
+<h2><a id="post-receive"></a>post-receive</h2>\r
+<div class="sectionbody">\r
+<p>This hook is invoked by <tt>git-receive-pack</tt> on the remote repository,\r
+which happens when a <tt>git push</tt> is done on a local repository.\r
+It executes on the remote repository once after all the refs have\r
+been updated.</p>\r
+<p>This hook executes once for the receive operation.  It takes no\r
+arguments, but gets the same information as the\r
+<a href="#pre-receive"><em>pre-receive</em></a>\r
+hook does on its standard input.</p>\r
+<p>This hook does not affect the outcome of <tt>git-receive-pack</tt>, as it\r
+is called after the real work is done.</p>\r
+<p>This supersedes the <a href="#post-update"><em>post-update</em></a> hook in that it gets\r
+both old and new values of all the refs in addition to their\r
+names.</p>\r
+<p>Both standard output and standard error output are forwarded to\r
+<tt>git-send-pack</tt> on the other end, so you can simply <tt>echo</tt> messages\r
+for the user.</p>\r
+<p>The default <em>post-receive</em> hook is empty, but there is\r
+a sample script <tt>post-receive-email</tt> provided in the <tt>contrib/hooks</tt>\r
+directory in git distribution, which implements sending commit\r
+emails.</p>\r
+</div>\r
+<h2><a id="post-update"></a>post-update</h2>\r
+<div class="sectionbody">\r
+<p>This hook is invoked by <tt>git-receive-pack</tt> on the remote repository,\r
+which happens when a <tt>git push</tt> is done on a local repository.\r
+It executes on the remote repository once after all the refs have\r
+been updated.</p>\r
+<p>It takes a variable number of parameters, each of which is the\r
+name of ref that was actually updated.</p>\r
+<p>This hook is meant primarily for notification, and cannot affect\r
+the outcome of <tt>git-receive-pack</tt>.</p>\r
+<p>The <em>post-update</em> hook can tell what are the heads that were pushed,\r
+but it does not know what their original and updated values are,\r
+so it is a poor place to do log old..new. The\r
+<a href="#post-receive"><em>post-receive</em></a> hook does get both original and\r
+updated values of the refs. You might consider it instead if you need\r
+them.</p>\r
+<p>When enabled, the default <em>post-update</em> hook runs\r
+<tt>git-update-server-info</tt> to keep the information used by dumb\r
+transports (e.g., HTTP) up-to-date.  If you are publishing\r
+a git repository that is accessible via HTTP, you should\r
+probably enable this hook.</p>\r
+<p>Both standard output and standard error output are forwarded to\r
+<tt>git-send-pack</tt> on the other end, so you can simply <tt>echo</tt> messages\r
+for the user.</p>\r
+</div>\r
+<h2>pre-auto-gc</h2>\r
+<div class="sectionbody">\r
+<p>This hook is invoked by <tt>git-gc --auto</tt>. It takes no parameter, and\r
+exiting with non-zero status from this script causes the <tt>git-gc --auto</tt>\r
+to abort.</p>\r
+</div>\r
+<h2>GIT</h2>\r
+<div class="sectionbody">\r
+<p>Part of the <a href="git.html">git(7)</a> suite</p>\r
+</div>\r
+<div id="footer">\r
+<div id="footer-text">\r
+Last updated 14-May-2008 22:24:43 UTC\r
+</div>\r
+</div>\r
+</body>\r
+</html>\r
similarity index 98%
rename from hooks.txt
rename to githooks.txt
index d89cc222610d01bd8b2a25681c6225cef51c2138..53747febd2042e147fac8f98431cf6d9b06bb08e 100644 (file)
--- a/hooks.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
index 9719311b42f1beadeca752888dbd12a05ce511f8..48ce747cf4dad592d642735856eb156e93d6cf30 100644 (file)
@@ -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",
index 3e4a9d9425239595a2e8a8e07c32141232000255..2ddbbe3c33a07da66e80654c1c87a6abe205b1dc 100644 (file)
@@ -472,7 +472,7 @@ hooks
         commands.  A handful of sample hooks are installed when\r
         <tt>git init</tt> is run, but all of them are disabled by\r
         default.  To enable, they need to be made executable.\r
-        Read <a href="hooks.html">hooks</a> for more details about\r
+        Read <a href="githooks.html">githooks(5)</a>[hooks] for more details about\r
         each hook.\r
 </p>\r
 </dd>\r
@@ -585,7 +585,7 @@ shallow
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 06-May-2008 06:35:00 UTC\r
+Last updated 14-May-2008 22:24:44 UTC\r
 </div>\r
 </div>\r
 </body>\r
index bbaed2e129fb9ced1752183099fdb40ea8e341b3..7fd187be8a34a3ebc6d8d543c868f1ca932990af 100644 (file)
@@ -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::
index 664ff11341a5f18dccfec109a2b1c31ca6cfa550..71d5f8e44f4969dc5e40ca3e4c8bc252e57fd8cf 100644 (file)
@@ -734,7 +734,7 @@ $ cd proj.git<br>
 $ git --bare update-server-info<br>
 $ chmod a+x hooks/post-update</p></div><p>(For an explanation of the last two lines, see
 <a href="git-update-server-info.html" target="_top">git-update-server-info(1)</a>, and the documentation
-<a href="hooks.html" target="_top">Hooks used by git</a>.)</p><p>Advertise the URL of proj.git.  Anybody else should then be able to
+<a href="githooks.html" target="_top">githooks(5)</a>[Hooks used by git].)</p><p>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:</p><div class="literallayout"><p>$ git clone http://yourserver.com/~you/proj.git</p></div><p>(See also
 <a href="howto/setup-git-server-over-http.txt" target="_top">setup-git-server-over-http</a>
 for a slightly more sophisticated setup using WebDAV which also
index 86b91a53e5c822782ed7682c83d435180d7b682f..e2db850150a683087491016159a0ff0a75eb879a 100644 (file)
@@ -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: