From: Jon Seymour Date: Mon, 14 May 2012 12:48:14 GMT Subject: Re: [PATCH v2] git-svn: clarify the referent of dcommit's optional argument Message-ID: In-Reply-To: <1336978405-17943-1-git-send-email-jon.seymour@gmail.com> On Mon, May 14, 2012 at 4:53 PM, Jon Seymour wrote: > The documentation of the dcommit subcommand is reworded to clarify that > the optional argument refers to a git branch, not an SVN branch. > > The discussion of the optional argument is put into its own paragraph > as is the guidance about using 'dcommit' in preference to 'set-tree'. > > Signed-off-by: Jon Seymour > --- >  Documentation/git-svn.txt | 14 ++++++++------ >  1 file changed, 8 insertions(+), 6 deletions(-) > > diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt > index 34ee785..27c4840 100644 > --- a/Documentation/git-svn.txt > +++ b/Documentation/git-svn.txt > @@ -189,18 +189,20 @@ and have no uncommitted changes. >        last fetched commit from the upstream SVN. > >  'dcommit':: > -       Commit each diff from a specified head directly to the SVN > +       Commit each diff from the current branch directly to the SVN >        repository, and then rebase or reset (depending on whether or >        not there is a diff between SVN and head).  This will create >        a revision in SVN for each commit in git. >        It is recommended that you run 'git svn' fetch and rebase (not >        pull or merge) your commits against the latest changes in the >        SVN repository. > -       An optional revision or branch argument may be specified, and > -       causes 'git svn' to do all work on that revision/branch > -       instead of HEAD. > -       This is advantageous over 'set-tree' (below) because it produces > -       cleaner, more linear history. > ++ > +When an optional git branch name (or a git commit object name) > +is specified as an argument, the subcommand works on the specified > +branch, not on the current branch. > ++ > +Use of 'dcommit' is preferred to 'set-tree' (below) because it produces > +cleaner, more linear history. >  + Mmmm. I wonder if I should have left the original wording of this paragraph, but switched the order with respect to the disucssion of the optional argument, so that the text reads: It is recommended that you run 'git svn' fetch and rebase (not pull or merge) your commits against the latest changes in the  SVN repository. This is advantageous over'set-tree' (below) because it produces cleaner, more linear history. When an optional git branch name (or a git commit object name) is specified as an argument, the subcommand works on the specified branch, not on the current branch. >  --no-rebase;; >        After committing, do not rebase or reset. > -- > 1.7.10.1.514.ge33c7ea >