Autogenerated HTML docs for v1.4.4-ge3d4
authorJunio C Hamano <junio@hera.kernel.org>
Sat, 18 Nov 2006 22:17:58 +0000 (22:17 +0000)
committerJunio C Hamano <junio@hera.kernel.org>
Sat, 18 Nov 2006 22:17:58 +0000 (22:17 +0000)
git-apply.html
git-apply.txt
git-runstatus.html [new file with mode: 0644]
git-runstatus.txt [new file with mode: 0644]
git.html
git.txt
glossary.html
glossary.txt
repository-layout.html
repository-layout.txt

index 18c90e94a3cfaaac7532bcefd10bda0604091cae..f71e40775c2f53ebc4388fff3a2fb937f92f9a69 100644 (file)
@@ -531,7 +531,7 @@ discouraged.</p>
 </ul>\r
 </dd>\r
 <dt>\r
---inacurate-eof\r
+--inaccurate-eof\r
 </dt>\r
 <dd>\r
 <p>\r
@@ -582,7 +582,7 @@ apply.whitespace
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 03-Oct-2006 08:40:51 UTC\r
+Last updated 18-Nov-2006 22:17:47 UTC\r
 </div>\r
 </div>\r
 </body>\r
index d9137c74898f839a8ee5e79daf1080b2ec882dfd..2cc32d1c5efa0ba9c69ce59d481ca852045096c0 100644 (file)
@@ -150,7 +150,7 @@ discouraged.
 * `strip` outputs warnings for a few such errors, strips out the
   trailing whitespaces and applies the patch.
 
---inacurate-eof::
+--inaccurate-eof::
        Under certain circumstances, some versions of diff do not correctly
        detect a missing new-line at the end of the file. As a result, patches
        created by such diff programs do not record incomplete lines
diff --git a/git-runstatus.html b/git-runstatus.html
new file mode 100644 (file)
index 0000000..ccbb05d
--- /dev/null
@@ -0,0 +1,362 @@
+<!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>git-runstatus(1)</title>\r
+</head>\r
+<body>\r
+<div id="header">\r
+<h1>\r
+git-runstatus(1) Manual Page\r
+</h1>\r
+<h2>NAME</h2>\r
+<div class="sectionbody">\r
+<p>git-runstatus -\r
+   A helper for git-status and git-commit\r
+</p>\r
+</div>\r
+</div>\r
+<h2>SYNOPSIS</h2>\r
+<div class="sectionbody">\r
+<p><em>git-runstatus</em> [--color|--nocolor] [--amend] [--verbose] [--untracked]</p>\r
+</div>\r
+<h2>DESCRIPTION</h2>\r
+<div class="sectionbody">\r
+<p>Examines paths in the working tree that has changes unrecorded\r
+to the index file, and changes between the index file and the\r
+current HEAD commit.  The former paths are what you _could_\r
+commit by running <em>git-update-index</em> before running <em>git\r
+commit</em>, and the latter paths are what you _would_ commit by\r
+running <em>git commit</em>.</p>\r
+<p>If there is no path that is different between the index file and\r
+the current HEAD commit, the command exits with non-zero status.</p>\r
+<p>Note that this is _not_ the user level command you would want to\r
+run from the command line.  Use <em>git-status</em> instead.</p>\r
+</div>\r
+<h2>OPTIONS</h2>\r
+<div class="sectionbody">\r
+<dl>\r
+<dt>\r
+--color\r
+</dt>\r
+<dd>\r
+<p>\r
+        Show colored status, highlighting modified file names.\r
+</p>\r
+</dd>\r
+<dt>\r
+--nocolor\r
+</dt>\r
+<dd>\r
+<p>\r
+        Turn off coloring.\r
+</p>\r
+</dd>\r
+<dt>\r
+--amend\r
+</dt>\r
+<dd>\r
+<p>\r
+        Show status based on HEAD^1, not HEAD, i.e. show what\r
+        <em>git-commit --amend</em> would do.\r
+</p>\r
+</dd>\r
+<dt>\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+        Show unified diff of all file changes.\r
+</p>\r
+</dd>\r
+<dt>\r
+--untracked\r
+</dt>\r
+<dd>\r
+<p>\r
+        Show files in untracked directories, too.  Without this\r
+        option only its name and a trailing slash are displayed\r
+        for each untracked directory.\r
+</p>\r
+</dd>\r
+</dl>\r
+</div>\r
+<h2>OUTPUT</h2>\r
+<div class="sectionbody">\r
+<p>The output from this command is designed to be used as a commit\r
+template comments, and all the output lines are prefixed with <em>#</em>.</p>\r
+</div>\r
+<h2>Author</h2>\r
+<div class="sectionbody">\r
+<p>Originally written by Linus Torvalds &lt;torvalds@osdl.org&gt; as part\r
+of git-commit, and later rewritten in C by Jeff King.</p>\r
+</div>\r
+<h2>Documentation</h2>\r
+<div class="sectionbody">\r
+<p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</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 18-Nov-2006 22:17:48 UTC\r
+</div>\r
+</div>\r
+</body>\r
+</html>\r
diff --git a/git-runstatus.txt b/git-runstatus.txt
new file mode 100644 (file)
index 0000000..89d7b92
--- /dev/null
@@ -0,0 +1,69 @@
+git-runstatus(1)
+================
+
+NAME
+----
+git-runstatus - A helper for git-status and git-commit
+
+
+SYNOPSIS
+--------
+'git-runstatus' [--color|--nocolor] [--amend] [--verbose] [--untracked]
+
+
+DESCRIPTION
+-----------
+Examines paths in the working tree that has changes unrecorded
+to the index file, and changes between the index file and the
+current HEAD commit.  The former paths are what you _could_
+commit by running 'git-update-index' before running 'git
+commit', and the latter paths are what you _would_ commit by
+running 'git commit'.
+
+If there is no path that is different between the index file and
+the current HEAD commit, the command exits with non-zero status.
+
+Note that this is _not_ the user level command you would want to
+run from the command line.  Use 'git-status' instead.
+
+
+OPTIONS
+-------
+--color::
+       Show colored status, highlighting modified file names.
+
+--nocolor::
+       Turn off coloring.
+
+--amend::
+       Show status based on HEAD^1, not HEAD, i.e. show what
+       'git-commit --amend' would do.
+
+--verbose::
+       Show unified diff of all file changes.
+
+--untracked::
+       Show files in untracked directories, too.  Without this
+       option only its name and a trailing slash are displayed
+       for each untracked directory.
+
+
+OUTPUT
+------
+The output from this command is designed to be used as a commit
+template comments, and all the output lines are prefixed with '#'.
+
+
+Author
+------
+Originally written by Linus Torvalds <torvalds@osdl.org> as part
+of git-commit, and later rewritten in C by Jeff King.
+
+Documentation
+--------------
+Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
+
+GIT
+---
+Part of the gitlink:git[7] suite
+
index 5948232ed3b55afa02dc845a4f890cd45c0acdb8..7e2f436f4f3ba62c95beabacfd2acf244e8ed5ba 100644 (file)
--- a/git.html
+++ b/git.html
@@ -940,6 +940,14 @@ ancillary user utilities.</p>
 </p>\r
 </dd>\r
 <dt>\r
+<a href="git-runstatus.html">git-runstatus(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+        A helper for git-status and git-commit.\r
+</p>\r
+</dd>\r
+<dt>\r
 <a href="git-send-email.html">git-send-email(1)</a>\r
 </dt>\r
 <dd>\r
@@ -2206,7 +2214,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 09-Nov-2006 07:37:41 UTC\r
+Last updated 18-Nov-2006 22:17:48 UTC\r
 </div>\r
 </div>\r
 </body>\r
diff --git a/git.txt b/git.txt
index 52bc05ad50e8c64734c0f5a33c5bbc551128e955..619d65685eb51cdad2ba7faeaa16223ca55b2b81 100644 (file)
--- a/git.txt
+++ b/git.txt
@@ -302,6 +302,9 @@ gitlink:git-request-pull[1]::
 gitlink:git-rev-parse[1]::
        Pick out and massage parameters.
 
+gitlink:git-runstatus[1]::
+       A helper for git-status and git-commit.
+
 gitlink:git-send-email[1]::
        Send patch e-mails out of "format-patch --mbox" output.
 
index cb6ad8d6f1e28407c58f5042933c8f95164a3a1e..d3ba439282edbf4daa2a2016c1b14bd78015d063 100644 (file)
@@ -860,6 +860,18 @@ div.exampleblock-content {
 </p>\r
 </dd>\r
 <dt>\r
+<a id="ref_symref"></a>symref\r
+</dt>\r
+<dd>\r
+<p>\r
+        Symbolic reference: instead of containing the <a href="#ref_SHA1">SHA1</a> id\r
+        itself, it is of the format <em><a href="#ref_ref">ref</a>: refs/some/thing</em> and when\r
+        referenced, it recursively dereferences to this reference. <em>HEAD</em> is a\r
+        prime example of a <a href="#ref_symref">symref</a>. Symbolic references are\r
+        manipulated with the <a href="git-symbolic-<a href="#ref_ref">ref</a>.html">git-symbolic-<a href="#ref_ref">ref</a>(1)</a> command.\r
+</p>\r
+</dd>\r
+<dt>\r
 <a id="ref_tag"></a>tag\r
 </dt>\r
 <dd>\r
@@ -968,7 +980,7 @@ the git-list &lt;git@vger.kernel.org&gt;.</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 12-Oct-2006 19:10:27 UTC\r
+Last updated 18-Nov-2006 22:17:51 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 7e560b0eea83ae7b32e17095f766d84c0b67671f..894883d7b60c4c79263323fc007406c4f3720bac 100644 (file)
@@ -282,6 +282,13 @@ SCM::
 SHA1::
        Synonym for object name.
 
+symref::
+       Symbolic reference: instead of containing the SHA1 id itself, it
+       is of the format 'ref: refs/some/thing' and when referenced, it
+       recursively dereferences to this reference. 'HEAD' is a prime
+       example of a symref. Symbolic references are manipulated with
+       the gitlink:git-symbolic-ref[1] command.
+
 topic branch::
        A regular git branch that is used by a developer to
        identify a conceptual line of development.  Since branches
index 90918067ed04f04dad38e7002996577935794431..b3bff63befe1d0290eb7733958d0c3c8dca80910 100644 (file)
@@ -390,12 +390,16 @@ HEAD
 </dt>\r
 <dd>\r
 <p>\r
-        A symlink of the form <tt>refs/heads/<em>name</em></tt> to point at\r
-        the current branch, if exists.  It does not mean much if\r
-        the repository is not associated with any working tree\r
+        A symref (see glossary) to the <tt>refs/heads/</tt> namespace\r
+        describing the currently active branch.  It does not mean\r
+        much if the repository is not associated with any working tree\r
         (i.e. a <em>bare</em> repository), but a valid git repository\r
-        <strong>must</strong> have such a symlink here.  It is legal if the\r
-        named branch <em>name</em> does not (yet) exist.\r
+        <strong>must</strong> have the HEAD file; some porcelains may use it to\r
+        guess the designated "default" branch of the repository\r
+        (usually <em>master</em>).  It is legal if the named branch\r
+        <em>name</em> does not (yet) exist.  In some legacy setups, it is\r
+        a symbolic link instead of a symref that points at the current\r
+        branch.\r
 </p>\r
 </dd>\r
 <dt>\r
@@ -523,7 +527,7 @@ logs/refs/tags/<tt>name</tt>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 03-Oct-2006 08:41:47 UTC\r
+Last updated 18-Nov-2006 22:17:50 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 275d18bb545f3b14ad1f7de50d4224f184a507f8..6d8c58ed205cb051cf2a1f8f495d37405cabd398 100644 (file)
@@ -70,12 +70,16 @@ refs/tags/`name`::
        object, or a tag object that points at a commit object).
 
 HEAD::
-       A symlink of the form `refs/heads/'name'` to point at
-       the current branch, if exists.  It does not mean much if
-       the repository is not associated with any working tree
+       A symref (see glossary) to the `refs/heads/` namespace
+       describing the currently active branch.  It does not mean
+       much if the repository is not associated with any working tree
        (i.e. a 'bare' repository), but a valid git repository
-       *must* have such a symlink here.  It is legal if the
-       named branch 'name' does not (yet) exist.
+       *must* have the HEAD file; some porcelains may use it to
+       guess the designated "default" branch of the repository
+       (usually 'master').  It is legal if the named branch
+       'name' does not (yet) exist.  In some legacy setups, it is
+       a symbolic link instead of a symref that points at the current
+       branch.
 
 branches::
        A slightly deprecated way to store shorthands to be used