contrib/git-svn: tell the user to not modify git-svn-HEAD directly
As a rule, interface branches to different SCMs should never be modified directly by the user. They are used exclusively for talking to the foreign SCM. Signed-off-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
Eric Wong committed
Feb 27, 2006 at 11:04 UTC
b705ba43c6202e3a64fbc28aa7b6b2adff7435ac
1 file changed
+8
-1
contrib/git-svn/git-svn.txt
+8
-1
@@ -43,6 +43,11 @@ fetch::
43
Fetch unfetched revisions from the SVN_URL we are tracking.
44
refs/heads/git-svn-HEAD will be updated to the latest revision.
45
46
+ Note: You should never attempt to modify the git-svn-HEAD branch
47
+ outside of git-svn. Instead, create a branch from git-svn-HEAD
48
+ and work on that branch. Use the 'commit' command (see below)
49
+ to write git commits back to git-svn-HEAD.
50
+
51
commit::
52
Commit specified commit or tree objects to SVN. This relies on
53
your imported fetch data being up-to-date. This makes
@@ -179,7 +184,9 @@ SVN repositories via one git repository. Simply set the GIT_SVN_ID
184
environment variable to a name other other than "git-svn" (the default)
185
and git-svn will ignore the contents of the $GIT_DIR/git-svn directory
186
and instead do all of its work in $GIT_DIR/$GIT_SVN_ID for that
182
-invocation.
187
+invocation. The interface branch will be $GIT_SVN_ID-HEAD, instead of
188
+git-svn-HEAD. Any $GIT_SVN_ID-HEAD branch should never be modified
189
+by the user outside of git-svn commands.
190
191
ADDITIONAL FETCH ARGUMENTS
192
--------------------------