diff options
| author | Eric Wong <normalperson@yhbt.net> | 2007-08-16 01:56:45 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2007-08-22 15:38:48 -0700 |
| commit | aabb2e515c334cbca9d9ae9873a188cef2c9b3ba (patch) | |
| tree | 782a84d1202cb93917edd4ef2e49aa6c1d1eaef7 /Documentation/git-svn.txt | |
| parent | 412876dcbb7ca10e64ed8118bc1995788d397782 (diff) | |
| download | git-aabb2e515c334cbca9d9ae9873a188cef2c9b3ba.tar.gz | |
git-svn: update documentation with CAVEATS section
Signed-off-by: Eric Wong <normalperson@yhbt.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-svn.txt')
| -rw-r--r-- | Documentation/git-svn.txt | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt index 816340b944..fbc58871f5 100644 --- a/Documentation/git-svn.txt +++ b/Documentation/git-svn.txt @@ -479,6 +479,38 @@ the user on the git side. git-svn does however follow copy history of the directory that it is tracking, however (much like how 'svn log' works). +CAVEATS +------- + +For the sake of simplicity and interoperating with a less-capable system +(SVN), it is recommended that all git-svn users clone, fetch and dcommit +directly from the SVN server, and avoid all git-clone/pull/merge/push +operations between git repositories and branches. The recommended +method of exchanging code between git branches and users is +git-format-patch and git-am, or just dcommiting to the SVN repository. + +Running 'git-merge' or 'git-pull' is NOT recommended on a branch you +plan to dcommit from. Subversion does not represent merges in any +reasonable or useful fashion; so users using Subversion cannot see any +merges you've made. Furthermore, if you merge or pull from a git branch +that is a mirror of an SVN branch, dcommit may commit to the wrong +branch. + +'git-clone' does not clone branches under the refs/remotes/ hierarchy or +any git-svn metadata, or config. So repositories created and managed with +using git-svn should use rsync(1) for cloning, if cloning is to be done +at all. + +Since 'dcommit' uses rebase internally, any git branches you git-push to +before dcommit on will require forcing an overwrite of the existing ref +on the remote repository. This is generally considered bad practice, +see the git-push(1) documentation for details. + +Do not use the --amend option of git-commit(1) on a change you've +already dcommitted. It is considered bad practice to --amend commits +you've already pushed to a remote repository for other users, and +dcommit with SVN is analogous to that. + BUGS ---- |