git-svn: update documentation with CAVEATS section
Signed-off-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Eric Wong committed
Aug 16, 2007 at 01:56 UTC
aabb2e515c334cbca9d9ae9873a188cef2c9b3ba
1 file changed
+32
Documentation/git-svn.txt
+32
@@ -479,6 +479,38 @@ the user on the git side. git-svn does however follow copy
479
history of the directory that it is tracking, however (much like
480
how 'svn log' works).
481
482
+CAVEATS
483
+-------
484
+
485
+For the sake of simplicity and interoperating with a less-capable system
486
+(SVN), it is recommended that all git-svn users clone, fetch and dcommit
487
+directly from the SVN server, and avoid all git-clone/pull/merge/push
488
+operations between git repositories and branches. The recommended
489
+method of exchanging code between git branches and users is
490
+git-format-patch and git-am, or just dcommiting to the SVN repository.
491
+
492
+Running 'git-merge' or 'git-pull' is NOT recommended on a branch you
493
+plan to dcommit from. Subversion does not represent merges in any
494
+reasonable or useful fashion; so users using Subversion cannot see any
495
+merges you've made. Furthermore, if you merge or pull from a git branch
496
+that is a mirror of an SVN branch, dcommit may commit to the wrong
497
+branch.
498
+
499
+'git-clone' does not clone branches under the refs/remotes/ hierarchy or
500
+any git-svn metadata, or config. So repositories created and managed with
501
+using git-svn should use rsync(1) for cloning, if cloning is to be done
502
+at all.
503
+
504
+Since 'dcommit' uses rebase internally, any git branches you git-push to
505
+before dcommit on will require forcing an overwrite of the existing ref
506
+on the remote repository. This is generally considered bad practice,
507
+see the git-push(1) documentation for details.
508
+
509
+Do not use the --amend option of git-commit(1) on a change you've
510
+already dcommitted. It is considered bad practice to --amend commits
511
+you've already pushed to a remote repository for other users, and
512
+dcommit with SVN is analogous to that.
513
+
514
BUGS
515
----
516