Autogenerated HTML docs for v1.2.4-g5a1f
authorJunio C Hamano <junio@hera.kernel.org>
Sat, 18 Mar 2006 07:45:42 +0000 (07:45 +0000)
committerJunio C Hamano <junio@hera.kernel.org>
Sat, 18 Mar 2006 07:45:42 +0000 (07:45 +0000)
14 files changed:
git-branch.html
git-branch.txt
git-checkout.html
git-checkout.txt
git-commit.html
git-commit.txt
git-init-db.html
git-init-db.txt
git-rebase.html
git-rebase.txt
git-show-branch.html
git-show-branch.txt
git.html
git.txt

index 8abc475..dcf5da7 100644 (file)
@@ -272,14 +272,17 @@ git-branch(1) Manual Page
 </div>\r
 <h2>SYNOPSIS</h2>\r
 <div class="sectionbody">\r
-<p><em>git-branch</em> [(-d | -D) &lt;branchname&gt;] | [[-f] &lt;branchname&gt; [&lt;start-point&gt;]]</p>\r
+<div class="verseblock">\r
+<div class="content"><em>git-branch</em> [[-f] &lt;branchname&gt; [&lt;start-point&gt;]]\r
+<em>git-branch</em> (-d | -D) &lt;branchname&gt;</div></div>\r
 </div>\r
 <h2>DESCRIPTION</h2>\r
 <div class="sectionbody">\r
 <p>If no argument is provided, show available branches and mark current\r
-branch with star. Otherwise, create a new branch of name &lt;branchname&gt;.</p>\r
-<p>If a starting point is also specified, that will be where the branch is\r
+branch with star. Otherwise, create a new branch of name &lt;branchname&gt;.\r
+If a starting point is also specified, that will be where the branch is\r
 created, otherwise it will be created at the current HEAD.</p>\r
+<p>With a <tt>-d</tt> or <tt>-D</tt> option, <tt>&lt;branchname&gt;</tt> will be deleted.</p>\r
 </div>\r
 <h2>OPTIONS</h2>\r
 <div class="sectionbody">\r
@@ -329,7 +332,7 @@ created, otherwise it will be created at the current HEAD.</p>
 <h3>Examples</h3>\r
 <dl>\r
 <dt>\r
-Start development off of a know tag\r
+Start development off of a known tag\r
 </dt>\r
 <dd>\r
 <div class="listingblock">\r
@@ -372,7 +375,7 @@ commits from todo branch.</tt></pre>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 10-Mar-2006 00:31:21 UTC\r
+Last updated 18-Mar-2006 07:45:34 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 4cd0cb9..71ecd85 100644 (file)
@@ -7,16 +7,20 @@ git-branch - Create a new branch, or remove an old one
 
 SYNOPSIS
 --------
-'git-branch' [(-d | -D) <branchname>] | [[-f] <branchname> [<start-point>]]
+[verse]
+'git-branch' [[-f] <branchname> [<start-point>]]
+'git-branch' (-d | -D) <branchname>
 
 DESCRIPTION
 -----------
 If no argument is provided, show available branches and mark current
 branch with star. Otherwise, create a new branch of name <branchname>.
-
 If a starting point is also specified, that will be where the branch is
 created, otherwise it will be created at the current HEAD.
 
+With a `-d` or `-D` option, `<branchname>` will be deleted.
+
+
 OPTIONS
 -------
 -d::
@@ -39,7 +43,7 @@ OPTIONS
 Examples
 ~~~~~~~~
 
-Start development off of a know tag::
+Start development off of a known tag::
 +
 ------------
 $ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
index f84db99..d8ec484 100644 (file)
@@ -272,14 +272,17 @@ git-checkout(1) Manual Page
 </div>\r
 <h2>SYNOPSIS</h2>\r
 <div class="sectionbody">\r
-<p><em>git-checkout</em> [-f] [-b &lt;new_branch&gt;] [-m] [&lt;branch&gt;] [&lt;paths&gt;&#8230;]</p>\r
+<div class="verseblock">\r
+<div class="content"><em>git-checkout</em> [-f] [-b &lt;new_branch&gt;] [-m] [&lt;branch&gt;]\r
+<em>git-checkout</em> [-m] [&lt;branch&gt;] &lt;paths&gt;&#8230;</div></div>\r
 </div>\r
 <h2>DESCRIPTION</h2>\r
 <div class="sectionbody">\r
-<p>When &lt;paths&gt; are not given, this command switches branches, by\r
+<p>When &lt;paths&gt; are not given, this command switches branches by\r
 updating the index and working tree to reflect the specified\r
 branch, &lt;branch&gt;, and updating HEAD to be &lt;branch&gt; or, if\r
-specified, &lt;new_branch&gt;.</p>\r
+specified, &lt;new_branch&gt;.  Using -b will cause &lt;new_branch&gt; to\r
+be created.</p>\r
 <p>When &lt;paths&gt; are given, this command does <strong>not</strong> switch\r
 branches.  It updates the named paths in the working tree from\r
 the index file (i.e. it runs <tt>git-checkout-index -f -u</tt>).  In\r
@@ -296,7 +299,7 @@ given paths before updating the working tree.</p>
 </dt>\r
 <dd>\r
 <p>\r
-        Force an re-read of everything.\r
+        Force a re-read of everything.\r
 </p>\r
 </dd>\r
 <dt>\r
@@ -312,11 +315,11 @@ given paths before updating the working tree.</p>
 </dt>\r
 <dd>\r
 <p>\r
-        If you have local modifications to a file that is\r
-        different between the current branch and the branch you\r
-        are switching to, the command refuses to switch\r
-        branches, to preserve your modifications in context.\r
-        With this option, a three-way merge between the current\r
+        If you have local modifications to one or more files that\r
+        are different between the current branch and the branch to\r
+        which you are switching, the command refuses to switch\r
+        branches in order to preserve your modifications in context.\r
+        However, with this option, a three-way merge between the current\r
         branch, your working tree contents, and the new branch\r
         is done, and you will be on the new branch.\r
 </p>\r
@@ -374,7 +377,7 @@ that branch.  You should instead write:</p>
 <li>\r
 <p>\r
 After working in a wrong branch, switching to the correct\r
-branch you would want to is done with:\r
+branch would be done using:\r
 </p>\r
 <div class="listingblock">\r
 <div class="content">\r
@@ -438,7 +441,7 @@ $ git update-index frotz</tt></pre>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 10-Mar-2006 00:31:21 UTC\r
+Last updated 18-Mar-2006 07:45:34 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 556e733..985bb2f 100644 (file)
@@ -7,15 +7,18 @@ git-checkout - Checkout and switch to a branch
 
 SYNOPSIS
 --------
-'git-checkout' [-f] [-b <new_branch>] [-m] [<branch>] [<paths>...]
+[verse]
+'git-checkout' [-f] [-b <new_branch>] [-m] [<branch>]
+'git-checkout' [-m] [<branch>] <paths>...
 
 DESCRIPTION
 -----------
 
-When <paths> are not given, this command switches branches, by
+When <paths> are not given, this command switches branches by
 updating the index and working tree to reflect the specified
 branch, <branch>, and updating HEAD to be <branch> or, if
-specified, <new_branch>.
+specified, <new_branch>.  Using -b will cause <new_branch> to
+be created.
 
 When <paths> are given, this command does *not* switch
 branches.  It updates the named paths in the working tree from
@@ -29,17 +32,17 @@ given paths before updating the working tree.
 OPTIONS
 -------
 -f::
-       Force an re-read of everything.
+       Force a re-read of everything.
 
 -b::
        Create a new branch and start it at <branch>.
 
 -m::
-       If you have local modifications to a file that is
-       different between the current branch and the branch you
-       are switching to, the command refuses to switch
-       branches, to preserve your modifications in context.
-       With this option, a three-way merge between the current
+       If you have local modifications to one or more files that
+       are different between the current branch and the branch to
+       which you are switching, the command refuses to switch
+       branches in order to preserve your modifications in context.
+       However, with this option, a three-way merge between the current
        branch, your working tree contents, and the new branch
        is done, and you will be on the new branch.
 +
@@ -82,7 +85,7 @@ $ git checkout -- hello.c
 ------------
 
 . After working in a wrong branch, switching to the correct
-branch you would want to is done with:
+branch would be done using:
 +
 ------------
 $ git checkout mytopic
index 4965cb9..16f2211 100644 (file)
@@ -282,6 +282,8 @@ git-commit(1) Manual Page
 <em>-a</em> is specified, and makes a commit object.  The command\r
 VISUAL and EDITOR environment variables to edit the commit log\r
 message.</p>\r
+<p>Several environment variable are used during commits.  They are\r
+documented in <a href="git-commit-tree.html">git-commit-tree(1)</a>.</p>\r
 <p>This command can run <tt>commit-msg</tt>, <tt>pre-commit</tt>, and\r
 <tt>post-commit</tt> hooks.  See <a href="hooks.html">hooks</a> for more\r
 information.</p>\r
@@ -480,7 +482,7 @@ Junio C Hamano &lt;junkio@cox.net&gt;</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 14-Feb-2006 07:59:59 UTC\r
+Last updated 18-Mar-2006 07:45:35 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 214ed23..d04b342 100644 (file)
@@ -18,6 +18,10 @@ Updates the index file for given paths, or all modified files if
 VISUAL and EDITOR environment variables to edit the commit log
 message.
 
+Several environment variable are used during commits.  They are
+documented in gitlink:git-commit-tree[1].
+
+
 This command can run `commit-msg`, `pre-commit`, and
 `post-commit` hooks.  See link:hooks.html[hooks] for more
 information.
index 34249db..1b4fb27 100644 (file)
@@ -3,7 +3,7 @@
 <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.1" />\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
@@ -282,7 +282,8 @@ git-init-db(1) Manual Page
 </dt>\r
 <dd>\r
 <p>\r
-        Provide the directory in from which templates will be used.\r
+        Provide the directory from which templates will be used.\r
+        The default template directory is <tt>/usr/share/git-core/templates</tt>.\r
 </p>\r
 </dd>\r
 <dt>\r
@@ -297,9 +298,16 @@ git-init-db(1) Manual Page
 </div>\r
 <h2>DESCRIPTION</h2>\r
 <div class="sectionbody">\r
-<p>This simply creates an empty git repository - basically a <tt>.git</tt> directory\r
-and <tt>.git/object/??/</tt>, <tt>.git/refs/heads</tt> and <tt>.git/refs/tags</tt> directories,\r
-and links <tt>.git/HEAD</tt> symbolically to <tt>.git/refs/heads/master</tt>.</p>\r
+<p>This command creates an empty git repository - basically a <tt>.git</tt> directory\r
+with subdirectories for <tt>objects</tt>, <tt>refs/heads</tt>, <tt>refs/tags</tt>, and\r
+templated files.\r
+An initial <tt>HEAD</tt> file that references the HEAD of the master branch\r
+is also created.</p>\r
+<p>If <tt>--template=&lt;template_directory&gt;</tt> is specified, <tt>&lt;template_directory&gt;</tt>\r
+is used as the source of the template files rather than the default.\r
+The template files include some directory structure, some suggested\r
+"exclude patterns", and copies of non-executing "hook" files.  The\r
+suggested patterns and hook files are all modifiable and extensible.</p>\r
 <p>If the <tt>$GIT_DIR</tt> environment variable is set then it specifies a path\r
 to use instead of <tt>./.git</tt> for the base of the repository.</p>\r
 <p>If the object storage directory is specified via the <tt>$GIT_OBJECT_DIRECTORY</tt>\r
@@ -346,7 +354,7 @@ $ git-add . <b>(2)</b>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 06-Jan-2006 17:12:38 PDT\r
+Last updated 18-Mar-2006 07:45:35 UTC\r
 </div>\r
 </div>\r
 </body>\r
index ea4d849..aeb1115 100644 (file)
@@ -14,7 +14,8 @@ SYNOPSIS
 OPTIONS
 -------
 --template=<template_directory>::
-       Provide the directory in from which templates will be used.
+       Provide the directory from which templates will be used.
+       The default template directory is `/usr/share/git-core/templates`.
 
 --shared::
        Specify that the git repository is to be shared amongst several users.
@@ -22,9 +23,17 @@ OPTIONS
 
 DESCRIPTION
 -----------
-This simply creates an empty git repository - basically a `.git` directory
-and `.git/object/??/`, `.git/refs/heads` and `.git/refs/tags` directories,
-and links `.git/HEAD` symbolically to `.git/refs/heads/master`.
+This command creates an empty git repository - basically a `.git` directory
+with subdirectories for `objects`, `refs/heads`, `refs/tags`, and
+templated files.
+An initial `HEAD` file that references the HEAD of the master branch
+is also created.
+
+If `--template=<template_directory>` is specified, `<template_directory>`
+is used as the source of the template files rather than the default.
+The template files include some directory structure, some suggested
+"exclude patterns", and copies of non-executing "hook" files.  The
+suggested patterns and hook files are all modifiable and extensible.
 
 If the `$GIT_DIR` environment variable is set then it specifies a path
 to use instead of `./.git` for the base of the repository.
@@ -38,7 +47,6 @@ repository. When specifying `--shared` the config variable "core.sharedRepositor
 is set to 'true' so that directories under `$GIT_DIR` are made group writable
 (and g+sx, since the git group may be not the primary group of all users).
 
-
 Running `git-init-db` in an existing repository is safe. It will not overwrite
 things that are already there. The primary reason for rerunning `git-init-db`
 is to pick up newly added templates.
index 8252b8a..91aa5cf 100644 (file)
@@ -289,7 +289,7 @@ accessible unless there are other references to it already.</p>
      /\r
 D---E---F---G master</tt></pre>\r
 </div></div>\r
-<p>From this point, the result of the following commands:</p>\r
+<p>From this point, the result of either of the following commands:</p>\r
 <div class="literalblock">\r
 <div class="content">\r
 <pre><tt>git-rebase master\r
@@ -302,7 +302,7 @@ git-rebase master topic</tt></pre>
              /\r
 D---E---F---G master</tt></pre>\r
 </div></div>\r
-<p>While, starting from the same point, the result of the following\r
+<p>While, starting from the same point, the result of either of the following\r
 commands:</p>\r
 <div class="literalblock">\r
 <div class="content">\r
@@ -339,7 +339,7 @@ D---E---F---G master</tt></pre>
 </p>\r
 </dd>\r
 <dt>\r
-&lt;head&gt;\r
+&lt;branch&gt;\r
 </dt>\r
 <dd>\r
 <p>\r
@@ -362,7 +362,7 @@ D---E---F---G master</tt></pre>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 10-Mar-2006 00:31:32 UTC\r
+Last updated 18-Mar-2006 07:45:36 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 4d5b546..b36276c 100644 (file)
@@ -25,7 +25,7 @@ Assume the following history exists and the current branch is "topic":
          /
     D---E---F---G master
 
-From this point, the result of the following commands:
+From this point, the result of either of the following commands:
 
     git-rebase master
     git-rebase master topic
@@ -36,7 +36,7 @@ would be:
                  /
     D---E---F---G master
 
-While, starting from the same point, the result of the following
+While, starting from the same point, the result of either of the following
 commands:
 
     git-rebase --onto master~1 master
@@ -58,7 +58,7 @@ OPTIONS
 <upstream>::
        Upstream branch to compare against.
 
-<head>::
+<branch>::
        Working branch; defaults to HEAD.
 
 Author
index 781a27b..fa5d322 100644 (file)
@@ -452,7 +452,7 @@ it, having the following in the configuration file may help:</p>
         default = heads/*\r
 </tt></pre>\r
 </div></div>\r
-<p>With this,<tt>git show-branch</tt> without extra parameters would show\r
+<p>With this, <tt>git show-branch</tt> without extra parameters would show\r
 only the primary branches.  In addition, if you happen to be on\r
 your topic branch, it is shown as well.</p>\r
 </div>\r
@@ -470,7 +470,7 @@ your topic branch, it is shown as well.</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 10-Mar-2006 00:31:36 UTC\r
+Last updated 18-Mar-2006 07:45:36 UTC\r
 </div>\r
 </div>\r
 </body>\r
index d3b6e62..f115b45 100644 (file)
@@ -141,7 +141,7 @@ it, having the following in the configuration file may help:
 
 ------------
 
-With this,`git show-branch` without extra parameters would show
+With this, `git show-branch` without extra parameters would show
 only the primary branches.  In addition, if you happen to be on
 your topic branch, it is shown as well.
 
index f899f74..f8cb445 100644 (file)
--- a/git.html
+++ b/git.html
@@ -958,6 +958,14 @@ the working tree.</p>
 </p>\r
 </dd>\r
 <dt>\r
+<a href="git-show.html">git-show(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+        Show one commit log and its diff.\r
+</p>\r
+</dd>\r
+<dt>\r
 <a href="git-show-branch.html">git-show-branch(1)</a>\r
 </dt>\r
 <dd>\r
@@ -2032,7 +2040,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 10-Mar-2006 00:31:39 UTC\r
+Last updated 18-Mar-2006 07:45:36 UTC\r
 </div>\r
 </div>\r
 </body>\r
diff --git a/git.txt b/git.txt
index 8610d36..de3934d 100644 (file)
--- a/git.txt
+++ b/git.txt
@@ -329,6 +329,9 @@ gitlink:git-revert[1]::
 gitlink:git-shortlog[1]::
        Summarizes 'git log' output.
 
+gitlink:git-show[1]::
+       Show one commit log and its diff.
+
 gitlink:git-show-branch[1]::
        Show branches and their commits.