git-svn: clarify the referent of dcommit's optional argument
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'. The section on REBASE vs. PULL/MERGE is reworded to incorporate the advice to prefer 'git rebase' previously in the description of 'dcommit'. Signed-off-by: Jon Seymour <jon.seymour@gmail.com> Acked-by: Eric Wong <normalperson@yhbt.net>
Jon Seymour committed
May 17, 2012 at 13:20 UTC
2b26b65f9abc77c4af87626452005a73edda0c8f
1 file changed
+19
-20
Documentation/git-svn.txt
+19
-20
@@ -189,18 +189,16 @@ and have no uncommitted changes.
189
last fetched commit from the upstream SVN.
190
191
'dcommit'::
192
- Commit each diff from a specified head directly to the SVN
192
+ Commit each diff from the current branch directly to the SVN
193
repository, and then rebase or reset (depending on whether or
194
not there is a diff between SVN and head). This will create
195
a revision in SVN for each commit in git.
196
- It is recommended that you run 'git svn' fetch and rebase (not
197
- pull or merge) your commits against the latest changes in the
198
- SVN repository.
199
- An optional revision or branch argument may be specified, and
200
- causes 'git svn' to do all work on that revision/branch
201
- instead of HEAD.
202
- This is advantageous over 'set-tree' (below) because it produces
203
- cleaner, more linear history.
196
++
197
+When an optional git branch name (or a git commit object name)
198
+is specified as an argument, the subcommand works on the specified
199
+branch, not on the current branch.
200
++
201
+Use of 'dcommit' is preferred to 'set-tree' (below).
202
+
203
--no-rebase;;
204
After committing, do not rebase or reset.
@@ -802,18 +800,19 @@ have each person clone that repository with 'git clone':
800
801
REBASE VS. PULL/MERGE
802
---------------------
805
-
806
-Originally, 'git svn' recommended that the 'remotes/git-svn' branch be
807
-pulled or merged from. This is because the author favored
803
+Prefer to use 'git svn rebase' or 'git rebase', rather than
804
+'git pull' or 'git merge' to synchronize unintegrated commits with a 'git svn'
805
+branch. Doing so will keep the history of unintegrated commits linear with
806
+respect to the upstream SVN repository and allow the use of the preferred
807
+'git svn dcommit' subcommand to push unintegrated commits back into SVN.
808
+
809
+Originally, 'git svn' recommended that developers pulled or merged from
810
+the 'git svn' branch. This was because the author favored
811
`git svn set-tree B` to commit a single head rather than the
809
-`git svn set-tree A..B` notation to commit multiple commits.
810
-
811
-If you use `git svn set-tree A..B` to commit several diffs and you do
812
-not have the latest remotes/git-svn merged into my-branch, you should
813
-use `git svn rebase` to update your work branch instead of `git pull` or
814
-`git merge`. `pull`/`merge` can cause non-linear history to be flattened
815
-when committing into SVN, which can lead to merge commits reversing
816
-previous commits in SVN.
812
+`git svn set-tree A..B` notation to commit multiple commits. Use of
813
+'git pull' or 'git merge' with `git svn set-tree A..B` will cause non-linear
814
+history to be flattened when committing into SVN and this can lead to merge
815
+commits unexpectedly reversing previous commits in SVN.
816
817
MERGE TRACKING
818
--------------