Autogenerated HTML docs for v1.4.2-ga7f0
authorJunio C Hamano <junio@hera.kernel.org>
Sat, 26 Aug 2006 08:43:31 +0000 (08:43 +0000)
committerJunio C Hamano <junio@hera.kernel.org>
Sat, 26 Aug 2006 08:43:31 +0000 (08:43 +0000)
12 files changed:
git-apply.html
git-apply.txt
git-blame.html
git-blame.txt
git-ls-remote.html
git-ls-remote.txt
git-svn.html
git-svn.txt
git.html
git.txt
gitk.html
gitk.txt

index 6cd5deaa7a54f3745326bb6f26a05723a86d6b1e..077a8673b53d92d0c773a439906dfadf5fd336f3 100644 (file)
@@ -274,9 +274,10 @@ git-apply(1) Manual Page
 <div class="sectionbody">\r
 <div class="verseblock">\r
 <div class="content"><em>git-apply</em> [--stat] [--numstat] [--summary] [--check] [--index] [--apply]\r
-          [--no-add] [--index-info] [--allow-binary-replacement] [-z] [-pNUM]\r
-          [-CNUM] [--whitespace=&lt;nowarn|warn|error|error-all|strip&gt;]\r
-          [&lt;patch&gt;&#8230;]</div></div>\r
+          [--no-add] [--index-info] [--allow-binary-replacement | --binary]\r
+          [-R | --reverse] [--reject] [-z] [-pNUM] [-CNUM] [--inaccurate-eof]\r
+          [--whitespace=&lt;nowarn|warn|error|error-all|strip&gt;] [--exclude=PATH]\r
+          [--cached] [--verbose] [&lt;patch&gt;&#8230;]</div></div>\r
 </div>\r
 <h2>DESCRIPTION</h2>\r
 <div class="sectionbody">\r
@@ -351,6 +352,16 @@ and a work tree.</p>
 </p>\r
 </dd>\r
 <dt>\r
+--cached\r
+</dt>\r
+<dd>\r
+<p>\r
+        Apply a patch without touching the working tree. Instead, take the\r
+        cached data, apply the patch, and store the result in the index,\r
+        without using the working tree. This implies <em>--index</em>.\r
+</p>\r
+</dd>\r
+<dt>\r
 --index-info\r
 </dt>\r
 <dd>\r
@@ -363,6 +374,26 @@ and a work tree.</p>
 </p>\r
 </dd>\r
 <dt>\r
+-R, --reverse\r
+</dt>\r
+<dd>\r
+<p>\r
+        Apply the patch in reverse.\r
+</p>\r
+</dd>\r
+<dt>\r
+--reject\r
+</dt>\r
+<dd>\r
+<p>\r
+        For atomicity, <a href="git-apply.html">git-apply(1)</a> by default fails the whole patch and\r
+        does not touch the working tree when some of the hunks\r
+        do not apply.  This option makes it apply\r
+        the parts of the patch that are applicable, and send the\r
+        rejected hunks to the standard output of the command.\r
+</p>\r
+</dd>\r
+<dt>\r
 -z\r
 </dt>\r
 <dd>\r
@@ -399,8 +430,8 @@ and a work tree.</p>
 </dt>\r
 <dd>\r
 <p>\r
-        If you use any of the options marked &#8220;Turns off\r
-        "apply"&#8221; above, git-apply reads and outputs the\r
+        If you use any of the options marked "Turns off\r
+        <em>apply</em>" above, <a href="git-apply.html">git-apply(1)</a> reads and outputs the\r
         information you asked without actually applying the\r
         patch.  Give this flag after those flags to also apply\r
         the patch.\r
@@ -419,7 +450,7 @@ and a work tree.</p>
 </p>\r
 </dd>\r
 <dt>\r
---allow-binary-replacement\r
+--allow-binary-replacement, --binary\r
 </dt>\r
 <dd>\r
 <p>\r
@@ -435,6 +466,16 @@ and a work tree.</p>
 </p>\r
 </dd>\r
 <dt>\r
+--exclude=&lt;path-pattern&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+        Don't apply changes to files matching the given path pattern. This can\r
+        be useful when importing patchsets, where you want to exclude certain\r
+        files or directories.\r
+</p>\r
+</dd>\r
+<dt>\r
 --whitespace=&lt;option&gt;\r
 </dt>\r
 <dd>\r
@@ -444,7 +485,7 @@ and a work tree.</p>
         line that solely consists of whitespaces).  By default,\r
         the command outputs warning messages and applies the\r
         patch.\r
-        When <tt>git-apply</tt> is used for statistics and not applying a\r
+        When <a href="git-apply.html">git-apply(1)</a> is used for statistics and not applying a\r
         patch, it defaults to <tt>nowarn</tt>.\r
         You can use different <tt>&lt;option&gt;</tt> to control this\r
         behavior:\r
@@ -480,6 +521,28 @@ and a work tree.</p>
 </li>\r
 </ul>\r
 </dd>\r
+<dt>\r
+--inacurate-eof\r
+</dt>\r
+<dd>\r
+<p>\r
+        Under certain circumstances, some versions of diff do not correctly\r
+        detect a missing new-line at the end of the file. As a result, patches\r
+        created by such diff programs do not record incomplete lines\r
+        correctly. This option adds support for applying such patches by\r
+        working around this bug.\r
+</p>\r
+</dd>\r
+<dt>\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+        Report progress to stderr. By default, only a message about the\r
+        current patch being applied will be printed. This option will cause\r
+        additional information to be reported.\r
+</p>\r
+</dd>\r
 </dl>\r
 </div>\r
 <h2>Configuration</h2>\r
@@ -510,7 +573,7 @@ apply.whitespace
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 15-Jul-2006 01:37:31 UTC\r
+Last updated 26-Aug-2006 08:43:06 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 2ff74949a73aa8670750105a7d292206877477c7..20e12ceda002d929ffc7ee13b77d0e23c7e91356 100644 (file)
@@ -10,9 +10,10 @@ SYNOPSIS
 --------
 [verse]
 'git-apply' [--stat] [--numstat] [--summary] [--check] [--index] [--apply]
-         [--no-add] [--index-info] [--allow-binary-replacement] [-z] [-pNUM]
-         [-CNUM] [--whitespace=<nowarn|warn|error|error-all|strip>]
-         [<patch>...]
+         [--no-add] [--index-info] [--allow-binary-replacement | --binary]
+         [-R | --reverse] [--reject] [-z] [-pNUM] [-CNUM] [--inaccurate-eof]
+         [--whitespace=<nowarn|warn|error|error-all|strip>] [--exclude=PATH]
+         [--cached] [--verbose] [<patch>...]
 
 DESCRIPTION
 -----------
@@ -55,6 +56,11 @@ OPTIONS
        up-to-date, it is flagged as an error.  This flag also
        causes the index file to be updated.
 
+--cached::
+       Apply a patch without touching the working tree. Instead, take the
+       cached data, apply the patch, and store the result in the index,
+       without using the working tree. This implies '--index'.
+
 --index-info::
        Newer git-diff output has embedded 'index information'
        for each blob to help identify the original version that
@@ -62,6 +68,16 @@ OPTIONS
        the original version of the blob is available locally,
        outputs information about them to the standard output.
 
+-R, --reverse::
+       Apply the patch in reverse.
+
+--reject::
+       For atomicity, gitlink:git-apply[1] by default fails the whole patch and
+       does not touch the working tree when some of the hunks
+       do not apply.  This option makes it apply
+       the parts of the patch that are applicable, and send the
+       rejected hunks to the standard output of the command.
+
 -z::
        When showing the index information, do not munge paths,
        but use NUL terminated machine readable format.  Without
@@ -80,8 +96,8 @@ OPTIONS
        ever ignored.
 
 --apply::
-       If you use any of the options marked ``Turns off
-       "apply"'' above, git-apply reads and outputs the
+       If you use any of the options marked "Turns off
+       'apply'" above, gitlink:git-apply[1] reads and outputs the
        information you asked without actually applying the
        patch.  Give this flag after those flags to also apply
        the patch.
@@ -93,7 +109,7 @@ OPTIONS
        the result with this option, which would apply the
        deletion part but not addition part.
 
---allow-binary-replacement::
+--allow-binary-replacement, --binary::
        When applying a patch, which is a git-enhanced patch
        that was prepared to record the pre- and post-image object
        name in full, and the path being patched exactly matches
@@ -104,13 +120,18 @@ OPTIONS
        result.  This allows binary files to be patched in a
        very limited way.
 
+--exclude=<path-pattern>::
+       Don't apply changes to files matching the given path pattern. This can
+       be useful when importing patchsets, where you want to exclude certain
+       files or directories.
+
 --whitespace=<option>::
        When applying a patch, detect a new or modified line
        that ends with trailing whitespaces (this includes a
        line that solely consists of whitespaces).  By default,
        the command outputs warning messages and applies the
        patch.
-       When `git-apply` is used for statistics and not applying a
+       When gitlink:git-apply[1] is used for statistics and not applying a
        patch, it defaults to `nowarn`.
        You can use different `<option>` to control this
        behavior:
@@ -124,6 +145,17 @@ OPTIONS
 * `strip` outputs warnings for a few such errors, strips out the
   trailing whitespaces and applies the patch.
 
+--inacurate-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
+       correctly. This option adds support for applying such patches by
+       working around this bug.
+
+--verbose::
+       Report progress to stderr. By default, only a message about the
+       current patch being applied will be printed. This option will cause
+       additional information to be reported.
 
 Configuration
 -------------
index 250f5ef252a6506901b40367b3aa7a8067d2fee9..f809e1a92c8bfe99dc2a00b97f7412ea88eface4 100644 (file)
@@ -266,18 +266,32 @@ git-blame(1) Manual Page
 <h2>NAME</h2>\r
 <div class="sectionbody">\r
 <p>git-blame -\r
-   Blame file lines on commits\r
+   Show what revision and author last modified each line of a file\r
 </p>\r
 </div>\r
 </div>\r
 <h2>SYNOPSIS</h2>\r
 <div class="sectionbody">\r
-<p>git-blame file [options] file [revision]</p>\r
+<p><em>git-blame</em> [-c] [-l] [-t] [-S &lt;revs-file&gt;] [--] &lt;file&gt; [&lt;rev&gt;]</p>\r
 </div>\r
 <h2>DESCRIPTION</h2>\r
 <div class="sectionbody">\r
-<p>Annotates each line in the given file with information from the commit\r
-which introduced the line. Start annotation from the given revision.</p>\r
+<p>Annotates each line in the given file with information from the revision which\r
+last modified the line. Optionally, start annotating from the given revision.</p>\r
+<p>This report doesn't tell you anything about lines which have been deleted or\r
+replaced; you need to use a tool such as <a href="git-diff.html">git-diff(1)</a> or the "pickaxe"\r
+interface briefly mentioned in the following paragraph.</p>\r
+<p>Apart from supporting file annotation, git also supports searching the\r
+development history for when a code snippet occured in a change. This makes it\r
+possible to track when a code snippet was added to a file, moved or copied\r
+between files, and eventually deleted or replaced. It works by searching for\r
+a text string in the diff. A small example:</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>$ git log --pretty=oneline -S'blame_usage'\r
+5040f17eba15504bad66b14a645bddd9b015ebb7 blame -S &lt;ancestry-file&gt;\r
+ea4c7f9bf69e781dd0cd88d2bccb2bf5cc15c9a7 git-blame: Make the output</tt></pre>\r
+</div></div>\r
 </div>\r
 <h2>OPTIONS</h2>\r
 <div class="sectionbody">\r
@@ -287,7 +301,7 @@ which introduced the line. Start annotation from the given revision.</p>
 </dt>\r
 <dd>\r
 <p>\r
-        Use the same output mode as git-annotate (Default: off).\r
+        Use the same output mode as <a href="git-annotate.html">git-annotate(1)</a> (Default: off).\r
 </p>\r
 </dd>\r
 <dt>\r
@@ -311,7 +325,7 @@ which introduced the line. Start annotation from the given revision.</p>
 </dt>\r
 <dd>\r
 <p>\r
-        Use revs from revs-file instead of calling git-rev-list.\r
+        Use revs from revs-file instead of calling <a href="git-rev-list.html">git-rev-list(1)</a>.\r
 </p>\r
 </dd>\r
 <dt>\r
@@ -338,7 +352,7 @@ which introduced the line. Start annotation from the given revision.</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 15-Jul-2006 01:37:33 UTC\r
+Last updated 26-Aug-2006 08:43:06 UTC\r
 </div>\r
 </div>\r
 </body>\r
index bfed945914c5de74d6f46e51ee8fbe459e4d8420..e1f89444a95618a1e520940a79389c854cf9d576 100644 (file)
@@ -3,21 +3,38 @@ git-blame(1)
 
 NAME
 ----
-git-blame - Blame file lines on commits
+git-blame - Show what revision and author last modified each line of a file
 
 SYNOPSIS
 --------
-git-blame file [options] file [revision]
+'git-blame' [-c] [-l] [-t] [-S <revs-file>] [--] <file> [<rev>]
 
 DESCRIPTION
 -----------
-Annotates each line in the given file with information from the commit
-which introduced the line. Start annotation from the given revision.
+
+Annotates each line in the given file with information from the revision which
+last modified the line. Optionally, start annotating from the given revision.
+
+This report doesn't tell you anything about lines which have been deleted or
+replaced; you need to use a tool such as gitlink:git-diff[1] or the "pickaxe"
+interface briefly mentioned in the following paragraph.
+
+Apart from supporting file annotation, git also supports searching the
+development history for when a code snippet occured in a change. This makes it
+possible to track when a code snippet was added to a file, moved or copied
+between files, and eventually deleted or replaced. It works by searching for
+a text string in the diff. A small example:
+
+-----------------------------------------------------------------------------
+$ git log --pretty=oneline -S'blame_usage'
+5040f17eba15504bad66b14a645bddd9b015ebb7 blame -S <ancestry-file>
+ea4c7f9bf69e781dd0cd88d2bccb2bf5cc15c9a7 git-blame: Make the output
+-----------------------------------------------------------------------------
 
 OPTIONS
 -------
 -c, --compatibility::
-       Use the same output mode as git-annotate (Default: off).
+       Use the same output mode as gitlink:git-annotate[1] (Default: off).
 
 -l, --long::
        Show long rev (Default: off).
@@ -26,7 +43,7 @@ OPTIONS
        Show raw timestamp (Default: off).
 
 -S, --rev-file <revs-file>::
-       Use revs from revs-file instead of calling git-rev-list.
+       Use revs from revs-file instead of calling gitlink:git-rev-list[1].
 
 -h, --help::
        Show help message.
index 129c295046d437f297e364d37a13b284fdc5819f..8cc179ff2fe6e42d7cf385eaec80192500a2f5f2 100644 (file)
@@ -266,17 +266,20 @@ git-ls-remote(1) Manual Page
 <h2>NAME</h2>\r
 <div class="sectionbody">\r
 <p>git-ls-remote -\r
-   Look at references other repository has\r
+   List references in a remote repository\r
 </p>\r
 </div>\r
 </div>\r
 <h2>SYNOPSIS</h2>\r
 <div class="sectionbody">\r
-<p><em>git-ls-remote</em> [--heads] [--tags] &lt;repository&gt; &lt;refs&gt;&#8230;</p>\r
+<div class="verseblock">\r
+<div class="content"><em>git-ls-remote</em> [--heads] [--tags]  [-u &lt;exec&gt; | --upload-pack &lt;exec&gt;]\r
+              &lt;repository&gt; &lt;refs&gt;&#8230;</div></div>\r
 </div>\r
 <h2>DESCRIPTION</h2>\r
 <div class="sectionbody">\r
-<p>Displays the references other repository has.</p>\r
+<p>Displays references available in a remote repository along with the associated\r
+commit IDs.</p>\r
 </div>\r
 <h2>OPTIONS</h2>\r
 <div class="sectionbody">\r
@@ -293,12 +296,24 @@ git-ls-remote(1) Manual Page
 </p>\r
 </dd>\r
 <dt>\r
+-u &lt;exec&gt;, --upload-pack=&lt;exec&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+        Specify the full path of <a href="git-upload-pack.html">git-upload-pack(1)</a> on the remote\r
+        host. This allows listing references from repositories accessed via\r
+        SSH and where the SSH deamon does not use the PATH configured by the\r
+        user. Also see the <em>--exec</em> option for <a href="git-peek-remote.html">git-peek-remote(1)</a>.\r
+</p>\r
+</dd>\r
+<dt>\r
 &lt;repository&gt;\r
 </dt>\r
 <dd>\r
 <p>\r
         Location of the repository.  The shorthand defined in\r
-        $GIT_DIR/branches/ can be used.\r
+        $GIT_DIR/branches/ can be used. Use "." (dot) to list references in\r
+        the local repository.\r
 </p>\r
 </dd>\r
 <dt>\r
@@ -346,7 +361,7 @@ c5db5456ae3b0873fc659c19fafdde22313cc441        refs/tags/v0.99.2
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 15-Jul-2006 01:37:53 UTC\r
+Last updated 26-Aug-2006 08:43:06 UTC\r
 </div>\r
 </div>\r
 </body>\r
index ae4c1a250e835bd39ee291088ba74c3c57604ac9..c8a4c5a4d9d2bead8686f1b582e985531a7f3591 100644 (file)
@@ -3,16 +3,19 @@ git-ls-remote(1)
 
 NAME
 ----
-git-ls-remote - Look at references other repository has
+git-ls-remote - List references in a remote repository
 
 
 SYNOPSIS
 --------
-'git-ls-remote' [--heads] [--tags] <repository> <refs>...
+[verse]
+'git-ls-remote' [--heads] [--tags]  [-u <exec> | --upload-pack <exec>]
+             <repository> <refs>...
 
 DESCRIPTION
 -----------
-Displays the references other repository has.
+Displays references available in a remote repository along with the associated
+commit IDs.
 
 
 OPTIONS
@@ -23,9 +26,16 @@ OPTIONS
        both, references stored in refs/heads and refs/tags are
        displayed.
 
+-u <exec>, --upload-pack=<exec>::
+       Specify the full path of gitlink:git-upload-pack[1] on the remote
+       host. This allows listing references from repositories accessed via
+       SSH and where the SSH deamon does not use the PATH configured by the
+       user. Also see the '--exec' option for gitlink:git-peek-remote[1].
+
 <repository>::
        Location of the repository.  The shorthand defined in
-       $GIT_DIR/branches/ can be used.
+       $GIT_DIR/branches/ can be used. Use "." (dot) to list references in
+       the local repository.
 
 <refs>...::
        When unspecified, all references, after filtering done
index 87686a2990b6a73655e67e6e5de9620b0ab92123..e237851e498a9a1939b8dd6640ef61e4cfa8a027 100644 (file)
@@ -277,9 +277,8 @@ git-svn(1) Manual Page
 <h2>DESCRIPTION</h2>\r
 <div class="sectionbody">\r
 <p>git-svn is a simple conduit for changesets between a single Subversion\r
-branch and git.</p>\r
-<p>git-svn is not to be confused with git-svnimport.  The were designed\r
-with very different goals in mind.</p>\r
+branch and git. It is not to be confused with <a href="git-svnimport.html">git-svnimport(1)</a>.\r
+They were designed with very different goals in mind.</p>\r
 <p>git-svn is designed for an individual developer who wants a\r
 bidirectional flow of changesets between a single branch in Subversion\r
 and an arbitrary number of branches in git.  git-svnimport is designed\r
@@ -297,7 +296,7 @@ git-svnimport is designed for.</p>
 <div class="sectionbody">\r
 <dl>\r
 <dt>\r
-init\r
+<em>init</em>\r
 </dt>\r
 <dd>\r
 <p>\r
@@ -307,30 +306,38 @@ init
 </p>\r
 </dd>\r
 <dt>\r
-fetch\r
+<em>fetch</em>\r
 </dt>\r
 <dd>\r
 <p>\r
-        Fetch unfetched revisions from the Subversion URL we are\r
-        tracking.  refs/remotes/git-svn will be updated to the\r
-        latest revision.\r
+Fetch unfetched revisions from the Subversion URL we are\r
+tracking.  refs/remotes/git-svn will be updated to the\r
+latest revision.\r
 </p>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>Note: You should never attempt to modify the remotes/git-svn\r
+<p>Note: You should never attempt to modify the remotes/git-svn\r
 branch outside of git-svn.  Instead, create a branch from\r
-remotes/git-svn and work on that branch.  Use the 'commit'\r
+remotes/git-svn and work on that branch.  Use the <em>commit</em>\r
 command (see below) to write git commits back to\r
-remotes/git-svn.</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>See 'Additional Fetch Arguments' if you are interested in\r
-manually joining branches on commit.</tt></pre>\r
-</div></div>\r
+remotes/git-svn.</p>\r
+<p>See <em><a href="#fetch-args">Additional Fetch Arguments</a></em> if you are interested in\r
+manually joining branches on commit.</p>\r
+</dd>\r
+<dt>\r
+<em>dcommit</em>\r
+</dt>\r
+<dd>\r
+<p>\r
+        Commit all diffs from the current HEAD directly to the SVN\r
+        repository, and then rebase or reset (depending on whether or\r
+        not there is a diff between SVN and HEAD).  It is recommended\r
+        that you run git-svn fetch and rebase (not pull) your commits\r
+        against the latest changes in the SVN repository.\r
+        This is advantageous over <em>commit</em> (below) because it produces\r
+        cleaner, more linear history.\r
+</p>\r
 </dd>\r
 <dt>\r
-commit\r
+<em>commit</em>\r
 </dt>\r
 <dd>\r
 <p>\r
@@ -343,12 +350,12 @@ commit
 </p>\r
 </dd>\r
 <dt>\r
-rebuild\r
+<em>rebuild</em>\r
 </dt>\r
 <dd>\r
 <p>\r
         Not a part of daily usage, but this is a useful command if\r
-        you've just cloned a repository (using git-clone) that was\r
+        you've just cloned a repository (using <a href="git-clone.html">git-clone(1)</a>) that was\r
         tracked with git-svn.  Unfortunately, git-clone does not clone\r
         git-svn metadata and the svn working tree that git-svn uses for\r
         its operations.  This rebuilds the metadata so git-svn can\r
@@ -358,7 +365,7 @@ rebuild
 </p>\r
 </dd>\r
 <dt>\r
-show-ignore\r
+<em>show-ignore</em>\r
 </dt>\r
 <dd>\r
 <p>\r
@@ -380,19 +387,13 @@ show-ignore
 </dt>\r
 <dd>\r
 <p>\r
-        Only used with the <em>fetch</em> command.\r
+Only used with the <em>fetch</em> command.\r
 </p>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>Takes any valid -r&lt;argument&gt; svn would accept and passes it\r
+<p>Takes any valid -r&lt;argument&gt; svn would accept and passes it\r
 directly to svn. -r&lt;ARG1&gt;:&lt;ARG2&gt; ranges and "{" DATE "}" syntax\r
 is also supported.  This is passed directly to svn, see svn\r
-documentation for more details.</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>This can allow you to make partial mirrors when running fetch.</tt></pre>\r
-</div></div>\r
+documentation for more details.</p>\r
+<p>This can allow you to make partial mirrors when running fetch.</p>\r
 </dd>\r
 <dt>\r
 -\r
@@ -402,34 +403,25 @@ documentation for more details.</tt></pre>
 </dt>\r
 <dd>\r
 <p>\r
-        Only used with the <em>commit</em> command.\r
+Only used with the <em>commit</em> command.\r
 </p>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>Read a list of commits from stdin and commit them in reverse\r
+<p>Read a list of commits from stdin and commit them in reverse\r
 order.  Only the leading sha1 is read from each line, so\r
-git-rev-list --pretty=oneline output can be used.</tt></pre>\r
-</div></div>\r
+git-rev-list --pretty=oneline output can be used.</p>\r
 </dd>\r
 <dt>\r
 --rmdir\r
 </dt>\r
 <dd>\r
 <p>\r
-        Only used with the <em>commit</em> command.\r
+Only used with the <em>commit</em> command.\r
 </p>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>Remove directories from the SVN tree if there are no files left\r
+<p>Remove directories from the SVN tree if there are no files left\r
 behind.  SVN can version empty directories, and they are not\r
 removed by default if there are no files left in them.  git\r
 cannot version empty directories.  Enabling this flag will make\r
-the commit to SVN act like git.</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>repo-config key: svn.rmdir</tt></pre>\r
-</div></div>\r
+the commit to SVN act like git.</p>\r
+<p>repo-config key: svn.rmdir</p>\r
 </dd>\r
 <dt>\r
 -e\r
@@ -439,18 +431,12 @@ the commit to SVN act like git.</tt></pre>
 </dt>\r
 <dd>\r
 <p>\r
-        Only used with the <em>commit</em> command.\r
+Only used with the <em>commit</em> command.\r
 </p>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>Edit the commit message before committing to SVN.  This is off by\r
+<p>Edit the commit message before committing to SVN.  This is off by\r
 default for objects that are commits, and forced on when committing\r
-tree objects.</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>repo-config key: svn.edit</tt></pre>\r
-</div></div>\r
+tree objects.</p>\r
+<p>repo-config key: svn.edit</p>\r
 </dd>\r
 <dt>\r
 -l&lt;num&gt;\r
@@ -460,18 +446,13 @@ tree objects.</tt></pre>
 </dt>\r
 <dd>\r
 <p>\r
-        Both of these are only used with the <em>commit</em> command.\r
+Both of these are only used with the <em>commit</em> command.\r
 </p>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>They are both passed directly to git-diff-tree see\r
-git-diff-tree(1) for more information.</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>repo-config key: svn.l\r
-repo-config key: svn.findcopiesharder</tt></pre>\r
-</div></div>\r
+<p>They are both passed directly to git-diff-tree see\r
+<a href="git-diff-tree.html">git-diff-tree(1)</a> for more information.</p>\r
+<div class="verseblock">\r
+<div class="content">repo-config key: svn.l\r
+repo-config key: svn.findcopiesharder</div></div>\r
 </dd>\r
 <dt>\r
 -A&lt;filename&gt;\r
@@ -481,27 +462,53 @@ repo-config key: svn.findcopiesharder</tt></pre>
 </dt>\r
 <dd>\r
 <p>\r
-        Syntax is compatible with the files used by git-svnimport and\r
-        git-cvsimport:\r
+Syntax is compatible with the files used by git-svnimport and\r
+git-cvsimport:\r
 </p>\r
-</dd>\r
-</dl>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt>loginname = Joe User &lt;user@example.com&gt;</tt></pre>\r
+<pre><tt>        loginname = Joe User &lt;user@example.com&gt;</tt></pre>\r
 </div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>If this option is specified and git-svn encounters an SVN\r
+<p>If this option is specified and git-svn encounters an SVN\r
 committer name that does not exist in the authors-file, git-svn\r
 will abort operation. The user will then have to add the\r
 appropriate entry.  Re-running the previous git-svn command\r
-after the authors-file is modified should continue operation.</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>repo-config key: svn.authors-file</tt></pre>\r
-</div></div>\r
+after the authors-file is modified should continue operation.</p>\r
+<p>repo-config key: svn.authors-file</p>\r
+</dd>\r
+<dt>\r
+-m\r
+</dt>\r
+<dt>\r
+--merge\r
+</dt>\r
+<dt>\r
+-s&lt;strategy&gt;\r
+</dt>\r
+<dt>\r
+--strategy=&lt;strategy&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+These are only used with the <em>dcommit</em> command.\r
+</p>\r
+<p>Passed directly to git-rebase when using <em>dcommit</em> if a\r
+<em>git-reset</em> cannot be used (see dcommit).</p>\r
+</dd>\r
+<dt>\r
+-n\r
+</dt>\r
+<dt>\r
+--dry-run\r
+</dt>\r
+<dd>\r
+<p>\r
+This is only used with the <em>dcommit</em> command.\r
+</p>\r
+<p>Print out the series of git arguments that would show\r
+which diffs would be committed to SVN.</p>\r
+</dd>\r
+</dl>\r
 </div>\r
 <h2>ADVANCED OPTIONS</h2>\r
 <div class="sectionbody">\r
@@ -514,29 +521,17 @@ after the authors-file is modified should continue operation.</tt></pre>
 </dt>\r
 <dd>\r
 <p>\r
-        Used with <em>fetch</em> or <em>commit</em>.\r
+Used with <em>fetch</em> or <em>commit</em>.\r
 </p>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>This can be used to join arbitrary git branches to remotes/git-svn\r
-on new commits where the tree object is equivalent.</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>When used with different GIT_SVN_ID values, tags and branches in\r
+<p>This can be used to join arbitrary git branches to remotes/git-svn\r
+on new commits where the tree object is equivalent.</p>\r
+<p>When used with different GIT_SVN_ID values, tags and branches in\r
 SVN can be tracked this way, as can some merges where the heads\r
 end up having completely equivalent content.  This can even be\r
-used to track branches across multiple SVN _repositories_.</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>This option may be specified multiple times, once for each\r
-branch.</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>repo-config key: svn.branch</tt></pre>\r
-</div></div>\r
+used to track branches across multiple SVN _repositories_.</p>\r
+<p>This option may be specified multiple times, once for each\r
+branch.</p>\r
+<p>repo-config key: svn.branch</p>\r
 </dd>\r
 <dt>\r
 -i&lt;GIT_SVN_ID&gt;\r
@@ -546,9 +541,10 @@ branch.</tt></pre>
 </dt>\r
 <dd>\r
 <p>\r
-        This sets GIT_SVN_ID (instead of using the environment).  See\r
-        the section on "Tracking Multiple Repositories or Branches" for\r
-        more information on using GIT_SVN_ID.\r
+This sets GIT_SVN_ID (instead of using the environment).  See the\r
+section on\r
+<em><a href="#tracking-multiple-repos">Tracking Multiple Repositories or Branches</a></em>\r
+for more information on using GIT_SVN_ID.\r
 </p>\r
 </dd>\r
 </dl>\r
@@ -561,43 +557,28 @@ branch.</tt></pre>
 </dt>\r
 <dd>\r
 <p>\r
-        Only used with the <em>rebuild</em> command.\r
+Only used with the <em>rebuild</em> command.\r
 </p>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>Run this if you used an old version of git-svn that used\r
+<p>Run this if you used an old version of git-svn that used\r
 "git-svn-HEAD" instead of "remotes/git-svn" as the branch\r
-for tracking the remote.</tt></pre>\r
-</div></div>\r
+for tracking the remote.</p>\r
 </dd>\r
 <dt>\r
 --no-ignore-externals\r
 </dt>\r
 <dd>\r
 <p>\r
-        Only used with the <em>fetch</em> and <em>rebuild</em> command.\r
+Only used with the <em>fetch</em> and <em>rebuild</em> command.\r
 </p>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>By default, git-svn passes --ignore-externals to svn to avoid\r
+<p>By default, git-svn passes --ignore-externals to svn to avoid\r
 fetching svn:external trees into git.  Pass this flag to enable\r
-externals tracking directly via git.</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>Versions of svn that do not support --ignore-externals are\r
+externals tracking directly via git.</p>\r
+<p>Versions of svn that do not support --ignore-externals are\r
 automatically detected and this flag will be automatically\r
-enabled for them.</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>Otherwise, do not enable this flag unless you know what you're\r
-doing.</tt></pre>\r
-</div></div>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>repo-config key: svn.noignoreexternals</tt></pre>\r
-</div></div>\r
+enabled for them.</p>\r
+<p>Otherwise, do not enable this flag unless you know what you're\r
+doing.</p>\r
+<p>repo-config key: svn.noignoreexternals</p>\r
 </dd>\r
 </dl>\r
 <h3>Basic Examples</h3>\r
@@ -614,12 +595,24 @@ doing.</tt></pre>
         git-svn commit &lt;tree-ish&gt; [&lt;tree-ish_2&gt; ...]\r
 # Commit all the git commits from my-branch that don't exist in SVN:\r
         git-svn commit remotes/git-svn..my-branch\r
-# Something is committed to SVN, pull the latest into your branch:\r
-        git-svn fetch &amp;&amp; git pull . remotes/git-svn\r
+# Something is committed to SVN, rebase the latest into your branch:\r
+        git-svn fetch &amp;&amp; git rebase remotes/git-svn\r
 # Append svn:ignore settings to the default git exclude file:\r
         git-svn show-ignore &gt;&gt; .git/info/exclude</tt></pre>\r
 </div></div>\r
 </div>\r
+<h2>REBASE VS. PULL</h2>\r
+<div class="sectionbody">\r
+<p>Originally, git-svn recommended that the remotes/git-svn branch be\r
+pulled from.  This is because the author favored <em>git-svn commit B</em>\r
+to commit a single head rather than the <em>git-svn commit A..B</em> notation\r
+to commit multiple commits.</p>\r
+<p>If you use <em>git-svn commit A..B</em> to commit several diffs and you do not\r
+have the latest remotes/git-svn merged into my-branch, you should use\r
+<em>git rebase</em> to update your work branch instead of <em>git pull</em>.  <em>pull</em>\r
+can cause non-linear history to be flattened when committing into SVN,\r
+which can lead to merge commits reversing previous commits in SVN.</p>\r
+</div>\r
 <h2>DESIGN PHILOSOPHY</h2>\r
 <div class="sectionbody">\r
 <p>Merge tracking in Subversion is lacking and doing branched development\r
@@ -628,7 +621,7 @@ any automated merge/branch tracking on the Subversion side and leaves it
 entirely up to the user on the git side.  It's simply not worth it to do\r
 a useful translation when the original signal is weak.</p>\r
 </div>\r
-<h2>TRACKING MULTIPLE REPOSITORIES OR BRANCHES</h2>\r
+<h2><a id="tracking-multiple-repos"></a>TRACKING MULTIPLE REPOSITORIES OR BRANCHES</h2>\r
 <div class="sectionbody">\r
 <p>This is for advanced users, most users should ignore this section.</p>\r
 <p>Because git-svn does not care about relationships between different\r
@@ -642,7 +635,7 @@ invocation.  The interface branch will be remotes/$GIT_SVN_ID, instead of
 remotes/git-svn.  Any remotes/$GIT_SVN_ID branch should never be modified\r
 by the user outside of git-svn commands.</p>\r
 </div>\r
-<h2>ADDITIONAL FETCH ARGUMENTS</h2>\r
+<h2><a id="fetch-args"></a>ADDITIONAL FETCH ARGUMENTS</h2>\r
 <div class="sectionbody">\r
 <p>This is for advanced users, most users should ignore this section.</p>\r
 <p>Unfetched SVN revisions may be imported as children of existing commits\r
@@ -650,20 +643,15 @@ by specifying additional arguments to <em>fetch</em>.  Additional parents may
 optionally be specified in the form of sha1 hex sums at the\r
 command-line.  Unfetched SVN revisions may also be tied to particular\r
 git commits with the following syntax:</p>\r
-<div class="literalblock">\r
+<div class="listingblock">\r
 <div class="content">\r
-<pre><tt>svn_revision_number=git_commit_sha1</tt></pre>\r
+<pre><tt>        svn_revision_number=git_commit_sha1</tt></pre>\r
+</div></div>\r
+<p>This allows you to tie unfetched SVN revision 375 to your current HEAD:</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>        git-svn fetch 375=$(git-rev-parse HEAD)</tt></pre>\r
 </div></div>\r
-<dl>\r
-<dt>\r
-This allows you to tie unfetched SVN revision 375 to your current HEAD\r
-</dt>\r
-<dd>\r
-<p>\r
-        <tt>git-svn fetch 375=$(git-rev-parse HEAD)</tt>\r
-</p>\r
-</dd>\r
-</dl>\r
 <h3>Advanced Example: Tracking a Reorganized Repository</h3>\r
 <p>If you're tracking a directory that has moved, or otherwise been\r
 branched or tagged off of another directory in the repository and you\r
@@ -712,6 +700,10 @@ the possible corner cases (git doesn't do it, either).  Renamed and
 copied files are fully supported if they're similar enough for git to\r
 detect them.</p>\r
 </div>\r
+<h2>SEE ALSO</h2>\r
+<div class="sectionbody">\r
+<p><a href="git-rebase.html">git-rebase(1)</a></p>\r
+</div>\r
 <h2>Author</h2>\r
 <div class="sectionbody">\r
 <p>Written by Eric Wong &lt;normalperson@yhbt.net&gt;.</p>\r
@@ -722,7 +714,7 @@ detect them.</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 15-Jul-2006 01:38:16 UTC\r
+Last updated 26-Aug-2006 08:43:07 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 7d868098448c7cc6712988c7bb1df541aedf6824..b7b63f7136a01d6f3383346c292e5c8aceb8ced4 100644 (file)
@@ -12,10 +12,8 @@ SYNOPSIS
 DESCRIPTION
 -----------
 git-svn is a simple conduit for changesets between a single Subversion
-branch and git.
-
-git-svn is not to be confused with git-svnimport.  The were designed
-with very different goals in mind.
+branch and git. It is not to be confused with gitlink:git-svnimport[1].
+They were designed with very different goals in mind.
 
 git-svn is designed for an individual developer who wants a
 bidirectional flow of changesets between a single branch in Subversion
@@ -34,26 +32,38 @@ git-svnimport is designed for.
 
 COMMANDS
 --------
-init::
+--
+
+'init'::
        Creates an empty git repository with additional metadata
        directories for git-svn.  The Subversion URL must be specified
        as a command-line argument.
 
-fetch::
-       Fetch unfetched revisions from the Subversion URL we are
-       tracking.  refs/remotes/git-svn will be updated to the
-       latest revision.
+'fetch'::
+
+Fetch unfetched revisions from the Subversion URL we are
+tracking.  refs/remotes/git-svn will be updated to the
+latest revision.
+
+Note: You should never attempt to modify the remotes/git-svn
+branch outside of git-svn.  Instead, create a branch from
+remotes/git-svn and work on that branch.  Use the 'commit'
+command (see below) to write git commits back to
+remotes/git-svn.
 
-       Note: You should never attempt to modify the remotes/git-svn
-       branch outside of git-svn.  Instead, create a branch from
-       remotes/git-svn and work on that branch.  Use the 'commit'
-       command (see below) to write git commits back to
-       remotes/git-svn.
+See '<<fetch-args,Additional Fetch Arguments>>' if you are interested in
+manually joining branches on commit.
 
-       See 'Additional Fetch Arguments' if you are interested in
-       manually joining branches on commit.
+'dcommit'::
+       Commit all diffs from the current HEAD directly to the SVN
+       repository, and then rebase or reset (depending on whether or
+       not there is a diff between SVN and HEAD).  It is recommended
+       that you run git-svn fetch and rebase (not pull) your commits
+       against the latest changes in the SVN repository.
+       This is advantageous over 'commit' (below) because it produces
+       cleaner, more linear history.
 
-commit::
+'commit'::
        Commit specified commit or tree objects to SVN.  This relies on
        your imported fetch data being up-to-date.  This makes
        absolutely no attempts to do patching when committing to SVN, it
@@ -61,9 +71,9 @@ commit::
        commit.  All merging is assumed to have taken place
        independently of git-svn functions.
 
-rebuild::
+'rebuild'::
        Not a part of daily usage, but this is a useful command if
-       you've just cloned a repository (using git-clone) that was
+       you've just cloned a repository (using gitlink:git-clone[1]) that was
        tracked with git-svn.  Unfortunately, git-clone does not clone
        git-svn metadata and the svn working tree that git-svn uses for
        its operations.  This rebuilds the metadata so git-svn can
@@ -71,130 +81,170 @@ rebuild::
        specified at the command-line if the directory/repository you're
        tracking has moved or changed protocols.
 
-show-ignore::
+'show-ignore'::
        Recursively finds and lists the svn:ignore property on
        directories.  The output is suitable for appending to
        the $GIT_DIR/info/exclude file.
 
+--
+
 OPTIONS
 -------
+--
+
 -r <ARG>::
 --revision <ARG>::
-       Only used with the 'fetch' command.
 
-       Takes any valid -r<argument> svn would accept and passes it
-       directly to svn. -r<ARG1>:<ARG2> ranges and "{" DATE "}" syntax
-       is also supported.  This is passed directly to svn, see svn
-       documentation for more details.
+Only used with the 'fetch' command.
+
+Takes any valid -r<argument> svn would accept and passes it
+directly to svn. -r<ARG1>:<ARG2> ranges and "{" DATE "}" syntax
+is also supported.  This is passed directly to svn, see svn
+documentation for more details.
 
-       This can allow you to make partial mirrors when running fetch.
+This can allow you to make partial mirrors when running fetch.
 
 -::
 --stdin::
-       Only used with the 'commit' command.
 
-       Read a list of commits from stdin and commit them in reverse
-       order.  Only the leading sha1 is read from each line, so
-       git-rev-list --pretty=oneline output can be used.
+Only used with the 'commit' command.
+
+Read a list of commits from stdin and commit them in reverse
+order.  Only the leading sha1 is read from each line, so
+git-rev-list --pretty=oneline output can be used.
 
 --rmdir::
-       Only used with the 'commit' command.
 
-       Remove directories from the SVN tree if there are no files left
-       behind.  SVN can version empty directories, and they are not
-       removed by default if there are no files left in them.  git
-       cannot version empty directories.  Enabling this flag will make
-       the commit to SVN act like git.
+Only used with the 'commit' command.
+
+Remove directories from the SVN tree if there are no files left
+behind.  SVN can version empty directories, and they are not
+removed by default if there are no files left in them.  git
+cannot version empty directories.  Enabling this flag will make
+the commit to SVN act like git.
 
-       repo-config key: svn.rmdir
+repo-config key: svn.rmdir
 
 -e::
 --edit::
-       Only used with the 'commit' command.
 
-       Edit the commit message before committing to SVN.  This is off by
-       default for objects that are commits, and forced on when committing
-       tree objects.
+Only used with the 'commit' command.
 
-       repo-config key: svn.edit
+Edit the commit message before committing to SVN.  This is off by
+default for objects that are commits, and forced on when committing
+tree objects.
+
+repo-config key: svn.edit
 
 -l<num>::
 --find-copies-harder::
-       Both of these are only used with the 'commit' command.
 
-       They are both passed directly to git-diff-tree see
-       git-diff-tree(1) for more information.
+Both of these are only used with the 'commit' command.
+
+They are both passed directly to git-diff-tree see
+gitlink:git-diff-tree[1] for more information.
 
-       repo-config key: svn.l
-       repo-config key: svn.findcopiesharder
+[verse]
+repo-config key: svn.l
+repo-config key: svn.findcopiesharder
 
 -A<filename>::
 --authors-file=<filename>::
 
-       Syntax is compatible with the files used by git-svnimport and
-       git-cvsimport:
+Syntax is compatible with the files used by git-svnimport and
+git-cvsimport:
 
 ------------------------------------------------------------------------
-loginname = Joe User <user@example.com>
+       loginname = Joe User <user@example.com>
 ------------------------------------------------------------------------
 
-       If this option is specified and git-svn encounters an SVN
-       committer name that does not exist in the authors-file, git-svn
-       will abort operation. The user will then have to add the
-       appropriate entry.  Re-running the previous git-svn command
-       after the authors-file is modified should continue operation.
+If this option is specified and git-svn encounters an SVN
+committer name that does not exist in the authors-file, git-svn
+will abort operation. The user will then have to add the
+appropriate entry.  Re-running the previous git-svn command
+after the authors-file is modified should continue operation.
+
+repo-config key: svn.authors-file
+
+-m::
+--merge::
+-s<strategy>::
+--strategy=<strategy>::
+
+These are only used with the 'dcommit' command.
 
-       repo-config key: svn.authors-file
+Passed directly to git-rebase when using 'dcommit' if a
+'git-reset' cannot be used (see dcommit).
+
+-n::
+--dry-run::
+
+This is only used with the 'dcommit' command.
+
+Print out the series of git arguments that would show
+which diffs would be committed to SVN.
+
+--
 
 ADVANCED OPTIONS
 ----------------
+--
+
 -b<refname>::
 --branch <refname>::
-       Used with 'fetch' or 'commit'.
+Used with 'fetch' or 'commit'.
 
-       This can be used to join arbitrary git branches to remotes/git-svn
-       on new commits where the tree object is equivalent.
+This can be used to join arbitrary git branches to remotes/git-svn
+on new commits where the tree object is equivalent.
 
-       When used with different GIT_SVN_ID values, tags and branches in
-       SVN can be tracked this way, as can some merges where the heads
-       end up having completely equivalent content.  This can even be
-       used to track branches across multiple SVN _repositories_.
+When used with different GIT_SVN_ID values, tags and branches in
+SVN can be tracked this way, as can some merges where the heads
+end up having completely equivalent content.  This can even be
+used to track branches across multiple SVN _repositories_.
 
-       This option may be specified multiple times, once for each
-       branch.
+This option may be specified multiple times, once for each
+branch.
 
-       repo-config key: svn.branch
+repo-config key: svn.branch
 
 -i<GIT_SVN_ID>::
 --id <GIT_SVN_ID>::
-       This sets GIT_SVN_ID (instead of using the environment).  See
-       the section on "Tracking Multiple Repositories or Branches" for
-       more information on using GIT_SVN_ID.
+
+This sets GIT_SVN_ID (instead of using the environment).  See the
+section on
+'<<tracking-multiple-repos,Tracking Multiple Repositories or Branches>>'
+for more information on using GIT_SVN_ID.
+
+--
 
 COMPATIBILITY OPTIONS
 ---------------------
+--
+
 --upgrade::
-       Only used with the 'rebuild' command.
+Only used with the 'rebuild' command.
 
-       Run this if you used an old version of git-svn that used
-       "git-svn-HEAD" instead of "remotes/git-svn" as the branch
-       for tracking the remote.
+Run this if you used an old version of git-svn that used
+"git-svn-HEAD" instead of "remotes/git-svn" as the branch
+for tracking the remote.
 
 --no-ignore-externals::
-       Only used with the 'fetch' and 'rebuild' command.
+Only used with the 'fetch' and 'rebuild' command.
+
+By default, git-svn passes --ignore-externals to svn to avoid
+fetching svn:external trees into git.  Pass this flag to enable
+externals tracking directly via git.
 
-       By default, git-svn passes --ignore-externals to svn to avoid
-       fetching svn:external trees into git.  Pass this flag to enable
-       externals tracking directly via git.
+Versions of svn that do not support --ignore-externals are
+automatically detected and this flag will be automatically
+enabled for them.
 
-       Versions of svn that do not support --ignore-externals are
-       automatically detected and this flag will be automatically
-       enabled for them.
+Otherwise, do not enable this flag unless you know what you're
+doing.
 
-       Otherwise, do not enable this flag unless you know what you're
-       doing.
+repo-config key: svn.noignoreexternals
 
-       repo-config key: svn.noignoreexternals
+--
 
 Basic Examples
 ~~~~~~~~~~~~~~
@@ -212,12 +262,26 @@ Tracking and contributing to an Subversion managed-project:
        git-svn commit <tree-ish> [<tree-ish_2> ...]
 # Commit all the git commits from my-branch that don't exist in SVN:
        git-svn commit remotes/git-svn..my-branch
-# Something is committed to SVN, pull the latest into your branch:
-       git-svn fetch && git pull . remotes/git-svn
+# Something is committed to SVN, rebase the latest into your branch:
+       git-svn fetch && git rebase remotes/git-svn
 # Append svn:ignore settings to the default git exclude file:
        git-svn show-ignore >> .git/info/exclude
 ------------------------------------------------------------------------
 
+REBASE VS. PULL
+---------------
+
+Originally, git-svn recommended that the remotes/git-svn branch be
+pulled from.  This is because the author favored 'git-svn commit B'
+to commit a single head rather than the 'git-svn commit A..B' notation
+to commit multiple commits.
+
+If you use 'git-svn commit A..B' to commit several diffs and you do not
+have the latest remotes/git-svn merged into my-branch, you should use
+'git rebase' to update your work branch instead of 'git pull'.  'pull'
+can cause non-linear history to be flattened when committing into SVN,
+which can lead to merge commits reversing previous commits in SVN.
+
 DESIGN PHILOSOPHY
 -----------------
 Merge tracking in Subversion is lacking and doing branched development
@@ -226,6 +290,7 @@ any automated merge/branch tracking on the Subversion side and leaves it
 entirely up to the user on the git side.  It's simply not worth it to do
 a useful translation when the original signal is weak.
 
+[[tracking-multiple-repos]]
 TRACKING MULTIPLE REPOSITORIES OR BRANCHES
 ------------------------------------------
 This is for advanced users, most users should ignore this section.
@@ -241,6 +306,7 @@ invocation.  The interface branch will be remotes/$GIT_SVN_ID, instead of
 remotes/git-svn.  Any remotes/$GIT_SVN_ID branch should never be modified
 by the user outside of git-svn commands.
 
+[[fetch-args]]
 ADDITIONAL FETCH ARGUMENTS
 --------------------------
 This is for advanced users, most users should ignore this section.
@@ -251,11 +317,15 @@ optionally be specified in the form of sha1 hex sums at the
 command-line.  Unfetched SVN revisions may also be tied to particular
 git commits with the following syntax:
 
+------------------------------------------------
        svn_revision_number=git_commit_sha1
+------------------------------------------------
 
-This allows you to tie unfetched SVN revision 375 to your current HEAD::
+This allows you to tie unfetched SVN revision 375 to your current HEAD:
 
-       `git-svn fetch 375=$(git-rev-parse HEAD)`
+------------------------------------------------
+       git-svn fetch 375=$(git-rev-parse HEAD)
+------------------------------------------------
 
 Advanced Example: Tracking a Reorganized Repository
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -310,6 +380,10 @@ the possible corner cases (git doesn't do it, either).  Renamed and
 copied files are fully supported if they're similar enough for git to
 detect them.
 
+SEE ALSO
+--------
+gitlink:git-rebase[1]
+
 Author
 ------
 Written by Eric Wong <normalperson@yhbt.net>.
index 8e6a00035951d1bd973c525eddb988d8598418f1..1047b53593172bc61db4e43717cf377393947608 100644 (file)
--- a/git.html
+++ b/git.html
@@ -272,8 +272,9 @@ git(7) Manual Page
 </div>\r
 <h2>SYNOPSIS</h2>\r
 <div class="sectionbody">\r
-<p><em>git</em> [--version] [--exec-path[=GIT_EXEC_PATH]] [-p|--paginate]\r
-        [--bare] [--git-dir=GIT_DIR] [--help] COMMAND [ARGS]</p>\r
+<div class="verseblock">\r
+<div class="content"><em>git</em> [--version] [--exec-path[=GIT_EXEC_PATH]] [-p|--paginate]\r
+    [--bare] [--git-dir=GIT_DIR] [--help] COMMAND [ARGS]</div></div>\r
 </div>\r
 <h2>DESCRIPTION</h2>\r
 <div class="sectionbody">\r
@@ -2168,7 +2169,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 13-Aug-2006 07:47:32 UTC\r
+Last updated 26-Aug-2006 08:43:08 UTC\r
 </div>\r
 </div>\r
 </body>\r
diff --git a/git.txt b/git.txt
index 3de5fa9c82de4d49a041480ce6681f69a97f167c..a9c87e38dae69b0799328917727867342eb5d22c 100644 (file)
--- a/git.txt
+++ b/git.txt
@@ -8,8 +8,9 @@ git - the stupid content tracker
 
 SYNOPSIS
 --------
+[verse]
 'git' [--version] [--exec-path[=GIT_EXEC_PATH]] [-p|--paginate]
-       [--bare] [--git-dir=GIT_DIR] [--help] COMMAND [ARGS]
+    [--bare] [--git-dir=GIT_DIR] [--help] COMMAND [ARGS]
 
 DESCRIPTION
 -----------
index 2c90c36f8ac980e4d587d8d870343d021fa44c3a..9d79ee94977b0ba958167e7e9543e2574e8939ae 100644 (file)
--- a/gitk.html
+++ b/gitk.html
@@ -266,35 +266,72 @@ gitk(1) Manual Page
 <h2>NAME</h2>\r
 <div class="sectionbody">\r
 <p>gitk -\r
-   Some git command not yet documented.\r
+   git repository browser\r
 </p>\r
 </div>\r
 </div>\r
 <h2>SYNOPSIS</h2>\r
 <div class="sectionbody">\r
-<p><em>gitk</em> [ --option ] &lt;args&gt;&#8230;</p>\r
+<p><em>gitk</em> [&lt;option&gt;&#8230;] [&lt;revs&gt;] [--] [&lt;path&gt;&#8230;]</p>\r
 </div>\r
 <h2>DESCRIPTION</h2>\r
 <div class="sectionbody">\r
-<p>Does something not yet documented.</p>\r
+<p>Displays changes in a repository or a selected set of commits. This includes\r
+visualizing the commit graph, showing information related to each commit, and\r
+the files in the trees of each revision.</p>\r
+<p>Historically, gitk was the first repository browser. It's written in tcl/tk\r
+and started off in a separate repository but was later merged into the main\r
+git repository.</p>\r
 </div>\r
 <h2>OPTIONS</h2>\r
 <div class="sectionbody">\r
+<p>To control which revisions to shown, the command takes options applicable to\r
+the <a href="git-rev-list.html">git-rev-list(1)</a> command. This manual page describes only the most\r
+frequently used options.</p>\r
 <dl>\r
 <dt>\r
---option\r
+-n &lt;number&gt;, --max-count=&lt;number&gt;\r
 </dt>\r
 <dd>\r
 <p>\r
-        Some option not yet documented.\r
+        Limits the number of commits to show.\r
 </p>\r
 </dd>\r
 <dt>\r
-&lt;args&gt;&#8230;\r
+--since=&lt;date&gt;\r
 </dt>\r
 <dd>\r
 <p>\r
-        Some argument not yet documented.\r
+        Show commits more recent than a specific date.\r
+</p>\r
+</dd>\r
+<dt>\r
+--until=&lt;date&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+        Show commits older than a specific date.\r
+</p>\r
+</dd>\r
+<dt>\r
+&lt;revs&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+        Limit the revisions to show. This can be either a single revision\r
+        meaning show from the given revision and back, or it can be a range in\r
+        the form "<em>&lt;from&gt;</em>..<em>&lt;to&gt;</em>" to show all revisions between <em>&lt;from&gt;</em> and\r
+        back to <em>&lt;to&gt;</em>. Note, more advanced revision selection can be applied.\r
+</p>\r
+</dd>\r
+<dt>\r
+&lt;path&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+        Limit commits to the ones touching files in the given paths. Note, to\r
+        avoid ambiguity wrt. revision names use "--" to separate the paths\r
+        from any preceeding options.\r
 </p>\r
 </dd>\r
 </dl>\r
@@ -323,13 +360,45 @@ gitk --since="2 weeks ago" -- gitk
 </dd>\r
 </dl>\r
 </div>\r
+<h2>See Also</h2>\r
+<div class="sectionbody">\r
+<dl>\r
+<dt>\r
+<em>qgit(1)</em>\r
+</dt>\r
+<dd>\r
+<p>\r
+        A repository browser written in C++ using Qt.\r
+</p>\r
+</dd>\r
+<dt>\r
+<em>gitview(1)</em>\r
+</dt>\r
+<dd>\r
+<p>\r
+        A repository browser written in Python using Gtk. It's based on\r
+        <em>bzrk(1)</em> and distributed in the contrib area of the git repository.\r
+</p>\r
+</dd>\r
+<dt>\r
+<em>tig(1)</em>\r
+</dt>\r
+<dd>\r
+<p>\r
+        A minimal repository browser and git tool output highlighter written\r
+        in C using Ncurses.\r
+</p>\r
+</dd>\r
+</dl>\r
+</div>\r
 <h2>Author</h2>\r
 <div class="sectionbody">\r
-<p>Written by Paul Mackerras &lt;paulus@samba.org&gt;</p>\r
+<p>Written by Paul Mackerras &lt;paulus@samba.org&gt;.</p>\r
 </div>\r
 <h2>Documentation</h2>\r
 <div class="sectionbody">\r
-<p>Documentation by Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>\r
+<p>Documentation by Junio C Hamano, Jonas Fonseca, and the git-list\r
+&lt;git@vger.kernel.org&gt;.</p>\r
 </div>\r
 <h2>GIT</h2>\r
 <div class="sectionbody">\r
@@ -337,7 +406,7 @@ gitk --since="2 weeks ago" -- gitk
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 15-Jul-2006 01:38:23 UTC\r
+Last updated 26-Aug-2006 08:43:08 UTC\r
 </div>\r
 </div>\r
 </body>\r
index cb482bf98ef9e2509ab2d2e1665933687538a574..23be0050b0023cbfecc5fa271b97a7d9855a73b0 100644 (file)
--- a/gitk.txt
+++ b/gitk.txt
@@ -3,26 +3,52 @@ gitk(1)
 
 NAME
 ----
-gitk - Some git command not yet documented.
-
+gitk - git repository browser
 
 SYNOPSIS
 --------
-'gitk' [ --option ] <args>...
+'gitk' [<option>...] [<revs>] [--] [<path>...]
 
 DESCRIPTION
 -----------
-Does something not yet documented.
+Displays changes in a repository or a selected set of commits. This includes
+visualizing the commit graph, showing information related to each commit, and
+the files in the trees of each revision.
 
+Historically, gitk was the first repository browser. It's written in tcl/tk
+and started off in a separate repository but was later merged into the main
+git repository.
 
 OPTIONS
 -------
---option::
-       Some option not yet documented.
+To control which revisions to shown, the command takes options applicable to
+the gitlink:git-rev-list[1] command. This manual page describes only the most
+frequently used options.
+
+-n <number>, --max-count=<number>::
+
+       Limits the number of commits to show.
+
+--since=<date>::
+
+       Show commits more recent than a specific date.
+
+--until=<date>::
+
+       Show commits older than a specific date.
 
-<args>...::
-       Some argument not yet documented.
+<revs>::
 
+       Limit the revisions to show. This can be either a single revision
+       meaning show from the given revision and back, or it can be a range in
+       the form "'<from>'..'<to>'" to show all revisions between '<from>' and
+       back to '<to>'. Note, more advanced revision selection can be applied.
+
+<path>::
+
+       Limit commits to the ones touching files in the given paths. Note, to
+       avoid ambiguity wrt. revision names use "--" to separate the paths
+       from any preceeding options.
 
 Examples
 --------
@@ -37,13 +63,27 @@ gitk --since="2 weeks ago" \-- gitk::
        The "--" is necessary to avoid confusion with the *branch* named
        'gitk'
 
+See Also
+--------
+'qgit(1)'::
+       A repository browser written in C++ using Qt.
+
+'gitview(1)'::
+       A repository browser written in Python using Gtk. It's based on
+       'bzrk(1)' and distributed in the contrib area of the git repository.
+
+'tig(1)'::
+       A minimal repository browser and git tool output highlighter written
+       in C using Ncurses.
+
 Author
 ------
-Written by Paul Mackerras <paulus@samba.org>
+Written by Paul Mackerras <paulus@samba.org>.
 
 Documentation
 --------------
-Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
+Documentation by Junio C Hamano, Jonas Fonseca, and the git-list
+<git@vger.kernel.org>.
 
 GIT
 ---