Autogenerated HTML docs for v1.5.0-rc0-gd222
authorJunio C Hamano <junio@hera.kernel.org>
Wed, 3 Jan 2007 22:02:12 +0000 (22:02 +0000)
committerJunio C Hamano <junio@hera.kernel.org>
Wed, 3 Jan 2007 22:02:12 +0000 (22:02 +0000)
config.txt
git-branch.html
git-branch.txt
git-repo-config.html
git-tag.html
git-tag.txt
tutorial.html
tutorial.txt

index 2f4fc252589017b13fff74445b85c951362a6236..4318bf9334d22541b741b4be3fe0315f0e1480e9 100644 (file)
@@ -145,6 +145,21 @@ branch.<name>.merge::
        this option, `git pull` defaults to merge the first refspec fetched.
        Specify multiple values to get an octopus merge.
 
+color.branch::
+       A boolean to enable/disable color in the output of
+       gitlink:git-branch[1]. May be set to `true` (or `always`),
+       `false` (or `never`) or `auto`, in which case colors are used
+       only when the output is to a terminal. Defaults to false.
+
+color.branch.<slot>::
+       Use customized color for branch coloration. `<slot>` is one of
+       `current` (the current branch), `local` (a local branch),
+       `remote` (a tracking branch in refs/remotes/), `plain` (other
+       refs), or `reset` (the normal terminal color).  The value for
+       these configuration variables can be one of: `normal`, `bold`,
+       `dim`, `ul`, `blink`, `reverse`, `reset`, `black`, `red`,
+       `green`, `yellow`, `blue`, `magenta`, `cyan`, or `white`.
+
 color.diff::
        When true (or `always`), always use colors in patch.
        When false (or `never`), never.  When set to `auto`, use
@@ -155,11 +170,8 @@ color.diff.<slot>::
        specifies which part of the patch to use the specified
        color, and is one of `plain` (context text), `meta`
        (metainformation), `frag` (hunk header), `old` (removed
-       lines), or `new` (added lines).  The value for these
-       configuration variables can be one of: `normal`, `bold`,
-       `dim`, `ul`, `blink`, `reverse`, `reset`, `black`,
-       `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, or
-       `white`.
+       lines), or `new` (added lines).  The values of these
+       variables may be specified as in color.branch.<slot>.
 
 color.pager::
        A boolean to enable/disable colored output when the pager is in
@@ -177,7 +189,7 @@ color.status.<slot>::
        `added` or `updated` (files which are added but not committed),
        `changed` (files which are changed but not added in the index),
        or `untracked` (files which are not tracked by git). The values of
-       these variables may be specified as in color.diff.<slot>.
+       these variables may be specified as in color.branch.<slot>.
 
 diff.renameLimit::
        The number of files to consider when performing the copy/rename
index f9cf223ad0fb0a7d284f980137a7f8d0e5075d20..924667a4c6ef2e920b04624fbaaacb1e897266af 100644 (file)
@@ -273,7 +273,7 @@ git-branch(1) Manual Page
 <h2>SYNOPSIS</h2>\r
 <div class="sectionbody">\r
 <div class="verseblock">\r
-<div class="content"><em>git-branch</em> [-r | -a] [-v [--abbrev=&lt;length&gt;]]\r
+<div class="content"><em>git-branch</em> [--color | --no-color] [-r | -a] [-v [--abbrev=&lt;length&gt;]]\r
 <em>git-branch</em> [-l] [-f] &lt;branchname&gt; [&lt;start-point&gt;]\r
 <em>git-branch</em> (-m | -M) [&lt;oldbranch&gt;] &lt;newbranch&gt;\r
 <em>git-branch</em> (-d | -D) [-r] &lt;branchname&gt;&#8230;</div></div>\r
@@ -352,6 +352,23 @@ to delete remote-tracking branches.</p>
 </p>\r
 </dd>\r
 <dt>\r
+--color\r
+</dt>\r
+<dd>\r
+<p>\r
+        Color branches to highlight current, local, and remote branches.\r
+</p>\r
+</dd>\r
+<dt>\r
+--no-color\r
+</dt>\r
+<dd>\r
+<p>\r
+        Turn off branch colors, even when the configuration file gives the\r
+        default to color output.\r
+</p>\r
+</dd>\r
+<dt>\r
 -r\r
 </dt>\r
 <dd>\r
@@ -494,7 +511,7 @@ a branch and check it out with a single command.</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 22-Dec-2006 07:28:11 UTC\r
+Last updated 03-Jan-2007 22:02:01 UTC\r
 </div>\r
 </div>\r
 </body>\r
index c464bd2fda2e4828d2e5a36ca05b4c66ad592f7c..e872fc89fc17caefc844bd5129f74040bada5cb9 100644 (file)
@@ -8,7 +8,7 @@ git-branch - List, create, or delete branches.
 SYNOPSIS
 --------
 [verse]
-'git-branch' [-r | -a] [-v [--abbrev=<length>]]
+'git-branch' [--color | --no-color] [-r | -a] [-v [--abbrev=<length>]]
 'git-branch' [-l] [-f] <branchname> [<start-point>]
 'git-branch' (-m | -M) [<oldbranch>] <newbranch>
 'git-branch' (-d | -D) [-r] <branchname>...
@@ -60,6 +60,13 @@ OPTIONS
 -M::
        Move/rename a branch even if the new branchname already exists.
 
+--color::
+       Color branches to highlight current, local, and remote branches.
+
+--no-color::
+       Turn off branch colors, even when the configuration file gives the
+       default to color output.
+
 -r::
        List or delete (if used with -d) the remote-tracking branches.
 
index ed5373e496ae05efa64d6294c6dcbd793631c2ca..5510abecaf29f65ae0809399cf4e14dd13d3fa63 100644 (file)
@@ -772,6 +772,31 @@ branch.&lt;name&gt;.merge
 </p>\r
 </dd>\r
 <dt>\r
+color.branch\r
+</dt>\r
+<dd>\r
+<p>\r
+        A boolean to enable/disable color in the output of\r
+        <a href="git-branch.html">git-branch(1)</a>. May be set to <tt>true</tt> (or <tt>always</tt>),\r
+        <tt>false</tt> (or <tt>never</tt>) or <tt>auto</tt>, in which case colors are used\r
+        only when the output is to a terminal. Defaults to false.\r
+</p>\r
+</dd>\r
+<dt>\r
+color.branch.&lt;slot&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+        Use customized color for branch coloration. <tt>&lt;slot&gt;</tt> is one of\r
+        <tt>current</tt> (the current branch), <tt>local</tt> (a local branch),\r
+        <tt>remote</tt> (a tracking branch in refs/remotes/), <tt>plain</tt> (other\r
+        refs), or <tt>reset</tt> (the normal terminal color).  The value for\r
+        these configuration variables can be one of: <tt>normal</tt>, <tt>bold</tt>,\r
+        <tt>dim</tt>, <tt>ul</tt>, <tt>blink</tt>, <tt>reverse</tt>, <tt>reset</tt>, <tt>black</tt>, <tt>red</tt>,\r
+        <tt>green</tt>, <tt>yellow</tt>, <tt>blue</tt>, <tt>magenta</tt>, <tt>cyan</tt>, or <tt>white</tt>.\r
+</p>\r
+</dd>\r
+<dt>\r
 color.diff\r
 </dt>\r
 <dd>\r
@@ -790,11 +815,8 @@ color.diff.&lt;slot&gt;
         specifies which part of the patch to use the specified\r
         color, and is one of <tt>plain</tt> (context text), <tt>meta</tt>\r
         (metainformation), <tt>frag</tt> (hunk header), <tt>old</tt> (removed\r
-        lines), or <tt>new</tt> (added lines).  The value for these\r
-        configuration variables can be one of: <tt>normal</tt>, <tt>bold</tt>,\r
-        <tt>dim</tt>, <tt>ul</tt>, <tt>blink</tt>, <tt>reverse</tt>, <tt>reset</tt>, <tt>black</tt>,\r
-        <tt>red</tt>, <tt>green</tt>, <tt>yellow</tt>, <tt>blue</tt>, <tt>magenta</tt>, <tt>cyan</tt>, or\r
-        <tt>white</tt>.\r
+        lines), or <tt>new</tt> (added lines).  The values of these\r
+        variables may be specified as in color.branch.&lt;slot&gt;.\r
 </p>\r
 </dd>\r
 <dt>\r
@@ -827,7 +849,7 @@ color.status.&lt;slot&gt;
         <tt>added</tt> or <tt>updated</tt> (files which are added but not committed),\r
         <tt>changed</tt> (files which are changed but not added in the index),\r
         or <tt>untracked</tt> (files which are not tracked by git). The values of\r
-        these variables may be specified as in color.diff.&lt;slot&gt;.\r
+        these variables may be specified as in color.branch.&lt;slot&gt;.\r
 </p>\r
 </dd>\r
 <dt>\r
@@ -1212,7 +1234,7 @@ receive.denyNonFastForwards
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 31-Dec-2006 08:29:27 UTC\r
+Last updated 03-Jan-2007 22:02:02 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 5977f477595d7e2210da3b4540788dd5cc0a8e8e..2a1259fd84550c455281b232b64b9859a1cd0524 100644 (file)
@@ -273,7 +273,7 @@ git-tag(1) Manual Page
 <h2>SYNOPSIS</h2>\r
 <div class="sectionbody">\r
 <div class="verseblock">\r
-<div class="content"><em>git-tag</em> [-a | -s | -u &lt;key-id&gt;] [-f | -d] [-m &lt;msg&gt; | -F &lt;file&gt;]\r
+<div class="content"><em>git-tag</em> [-a | -s | -u &lt;key-id&gt;] [-f | -d | -v] [-m &lt;msg&gt; | -F &lt;file&gt;]\r
          &lt;name&gt; [&lt;head&gt;]\r
 <em>git-tag</em> -l [&lt;pattern&gt;]</div></div>\r
 </div>\r
@@ -293,6 +293,7 @@ written (i.e. a lightweight tag).</p>
 committer identity for the current user is used to find the\r
 GnuPG key for signing.</p>\r
 <p><tt>-d &lt;tag&gt;</tt> deletes the tag.</p>\r
+<p><tt>-v &lt;tag&gt;</tt> verifies the gpg signature of the tag.</p>\r
 <p><tt>-l &lt;pattern&gt;</tt> lists tags that match the given pattern (or all\r
 if no pattern is given).</p>\r
 </div>\r
@@ -340,6 +341,14 @@ if no pattern is given).</p>
 </p>\r
 </dd>\r
 <dt>\r
+-v\r
+</dt>\r
+<dd>\r
+<p>\r
+        Verify the gpg signature of given the tag\r
+</p>\r
+</dd>\r
+<dt>\r
 -l &lt;pattern&gt;\r
 </dt>\r
 <dd>\r
@@ -381,7 +390,7 @@ Junio C Hamano &lt;junkio@cox.net&gt; and Chris Wright &lt;chrisw@osdl.org&gt;.<
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 22-Dec-2006 07:28:11 UTC\r
+Last updated 03-Jan-2007 22:02:03 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 48b82b86f83df4e3fb381da329b48fe12a4ce82d..80bece0775d14206028254c0bd2ed286b81aa180 100644 (file)
@@ -9,7 +9,7 @@ git-tag - Create a tag object signed with GPG
 SYNOPSIS
 --------
 [verse]
-'git-tag' [-a | -s | -u <key-id>] [-f | -d] [-m <msg> | -F <file>]
+'git-tag' [-a | -s | -u <key-id>] [-f | -d | -v] [-m <msg> | -F <file>]
         <name> [<head>]
 'git-tag' -l [<pattern>]
 
@@ -35,6 +35,8 @@ GnuPG key for signing.
 
 `-d <tag>` deletes the tag.
 
+`-v <tag>` verifies the gpg signature of the tag.
+
 `-l <pattern>` lists tags that match the given pattern (or all
 if no pattern is given).
 
@@ -55,6 +57,9 @@ OPTIONS
 -d::
        Delete an existing tag with the given name
 
+-v::
+       Verify the gpg signature of given the tag
+
 -l <pattern>::
        List tags that match the given pattern (or all if no pattern is given).
 
index 6b693d6bc5910c1a7cc1ac9f12c663c96a764f32..a29d122424ab5caae42366da868b072229990979 100644 (file)
@@ -318,15 +318,18 @@ of all the files to the repository.</p>
 <div class="content">\r
 <pre><tt>$ git diff</tt></pre>\r
 </div></div>\r
-<p>to review your changes.  When you're done,</p>\r
+<p>to review your changes.  When you're done, tell git that you\r
+want the updated contents of these files in the commit and then\r
+make a commit, like this:</p>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt>$ git commit file1 file2...</tt></pre>\r
+<pre><tt>$ git add file1 file...\r
+$ git commit</tt></pre>\r
 </div></div>\r
-<p>will again prompt your for a message describing the change, and then\r
+<p>This will again prompt your for a message describing the change, and then\r
 record the new versions of the files you listed.  It is cumbersome\r
-to list all files and you can say <tt>-a</tt> (which stands for <em>all</em>)\r
-instead.</p>\r
+to list all files and you can say <tt>git commit -a</tt> (which stands for <em>all</em>)\r
+instead of running <tt>git add</tt> beforehand.</p>\r
 <div class="listingblock">\r
 <div class="content">\r
 <pre><tt>$ git commit -a</tt></pre>\r
@@ -335,7 +338,7 @@ instead.</p>
 begin the commit message with a single short (less than 50 character)\r
 line summarizing the change, followed by a blank line and then a more\r
 thorough description.  Tools that turn commits into email, for\r
-example, use the first line on the Subject line and the rest of the\r
+example, use the first line on the Subject: line and the rest of the\r
 commit in the body.</p>\r
 </div>\r
 <h2>Git tracks content not files</h2>\r
@@ -389,6 +392,12 @@ and/or <em>git commit -a</em>.</p>
 <div class="content">\r
 <pre><tt>$ git log -p</tt></pre>\r
 </div></div>\r
+<p>Often the overview of the change is useful to get a feel of\r
+each step</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>$ git log --stat --summary</tt></pre>\r
+</div></div>\r
 </div>\r
 <h2>Managing branches</h2>\r
 <div class="sectionbody">\r
@@ -457,6 +466,13 @@ conflicts,</p>
 <pre><tt>$ gitk</tt></pre>\r
 </div></div>\r
 <p>will show a nice graphical representation of the resulting history.</p>\r
+<p>At this point you could delete the experimental branch with</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>$ git branch -d experimental</tt></pre>\r
+</div></div>\r
+<p>This command ensures that the changes in the experimental branch are\r
+already in the current branch.</p>\r
 <p>If you develop on a branch crazy-idea, then regret it, you can always\r
 delete the branch with</p>\r
 <div class="listingblock">\r
@@ -591,7 +607,7 @@ commit.</p>
 <div class="content">\r
 <pre><tt>$ git show c82a22c39cbc32576f64f5c6b3f24b99ea8149c7</tt></pre>\r
 </div></div>\r
-<p>But there other ways to refer to commits.  You can use any initial\r
+<p>But there are other ways to refer to commits.  You can use any initial\r
 part of the name that is long enough to uniquely identify the commit:</p>\r
 <div class="listingblock">\r
 <div class="content">\r
@@ -600,8 +616,8 @@ part of the name that is long enough to uniquely identify the commit:</p>
 $ git show HEAD         # the tip of the current branch\r
 $ git show experimental # the tip of the "experimental" branch</tt></pre>\r
 </div></div>\r
-<p>Every commit has at least one "parent" commit, which points to the\r
-previous state of the project:</p>\r
+<p>Every commit usually has one "parent" commit\r
+which points to the previous state of the project:</p>\r
 <div class="listingblock">\r
 <div class="content">\r
 <pre><tt>$ git show HEAD^  # to see the parent of HEAD\r
@@ -701,10 +717,10 @@ of the file:</p>
 <div class="content">\r
 <pre><tt>$ git diff v2.5:Makefile HEAD:Makefile.in</tt></pre>\r
 </div></div>\r
-<p>You can also use "git cat-file -p" to see any such file:</p>\r
+<p>You can also use "git show" to see any such file:</p>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt>$ git cat-file -p v2.5:Makefile</tt></pre>\r
+<pre><tt>$ git show v2.5:Makefile</tt></pre>\r
 </div></div>\r
 </div>\r
 <h2>Next Steps</h2>\r
@@ -767,7 +783,7 @@ digressions that may be interesting at this point are:</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 01-Jan-2007 03:20:15 UTC\r
+Last updated 03-Jan-2007 22:02:04 UTC\r
 </div>\r
 </div>\r
 </body>\r
index d043e844d2303d6c1c79eec50a2cd7621469c5b8..79884d9c74d3175e179dc5a83e9163908242d6ca 100644 (file)
@@ -65,16 +65,19 @@ Try modifying some files, then run
 $ git diff
 ------------------------------------------------
 
-to review your changes.  When you're done,
+to review your changes.  When you're done, tell git that you
+want the updated contents of these files in the commit and then
+make a commit, like this:
 
 ------------------------------------------------
-$ git commit file1 file2...
+$ git add file1 file...
+$ git commit
 ------------------------------------------------
 
-will again prompt your for a message describing the change, and then
+This will again prompt your for a message describing the change, and then
 record the new versions of the files you listed.  It is cumbersome
-to list all files and you can say `-a` (which stands for 'all')
-instead.
+to list all files and you can say `git commit -a` (which stands for 'all')
+instead of running `git add` beforehand.
 
 ------------------------------------------------
 $ git commit -a
@@ -84,7 +87,7 @@ A note on commit messages: Though not required, it's a good idea to
 begin the commit message with a single short (less than 50 character)
 line summarizing the change, followed by a blank line and then a more
 thorough description.  Tools that turn commits into email, for
-example, use the first line on the Subject line and the rest of the
+example, use the first line on the Subject: line and the rest of the
 commit in the body.
 
 
@@ -142,6 +145,13 @@ If you also want to see complete diffs at each step, use
 $ git log -p
 ------------------------------------------------
 
+Often the overview of the change is useful to get a feel of
+each step
+
+------------------------------------------------
+$ git log --stat --summary
+------------------------------------------------
+
 Managing branches
 -----------------
 
@@ -222,6 +232,15 @@ $ gitk
 
 will show a nice graphical representation of the resulting history.
 
+At this point you could delete the experimental branch with
+
+------------------------------------------------
+$ git branch -d experimental
+------------------------------------------------
+
+This command ensures that the changes in the experimental branch are
+already in the current branch.
+
 If you develop on a branch crazy-idea, then regret it, you can always
 delete the branch with
 
@@ -381,7 +400,7 @@ commit.
 $ git show c82a22c39cbc32576f64f5c6b3f24b99ea8149c7
 -------------------------------------
 
-But there other ways to refer to commits.  You can use any initial
+But there are other ways to refer to commits.  You can use any initial
 part of the name that is long enough to uniquely identify the commit:
 
 -------------------------------------
@@ -391,8 +410,8 @@ $ git show HEAD             # the tip of the current branch
 $ git show experimental        # the tip of the "experimental" branch
 -------------------------------------
 
-Every commit has at least one "parent" commit, which points to the
-previous state of the project:
+Every commit usually has one "parent" commit
+which points to the previous state of the project:
 
 -------------------------------------
 $ git show HEAD^  # to see the parent of HEAD
@@ -510,10 +529,10 @@ of the file:
 $ git diff v2.5:Makefile HEAD:Makefile.in
 -------------------------------------
 
-You can also use "git cat-file -p" to see any such file:
+You can also use "git show" to see any such file:
 
 -------------------------------------
-$ git cat-file -p v2.5:Makefile
+$ git show v2.5:Makefile
 -------------------------------------
 
 Next Steps