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>
This commit is contained in:
Eric Wong 2006-02-27 11:04:02 -08:00 committed by Junio C Hamano
parent c447f10f99
commit b705ba43c6

View File

@ -43,6 +43,11 @@ fetch::
Fetch unfetched revisions from the SVN_URL we are tracking.
refs/heads/git-svn-HEAD will be updated to the latest revision.
Note: You should never attempt to modify the git-svn-HEAD branch
outside of git-svn. Instead, create a branch from git-svn-HEAD
and work on that branch. Use the 'commit' command (see below)
to write git commits back to git-svn-HEAD.
commit::
Commit specified commit or tree objects to SVN. This relies on
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
environment variable to a name other other than "git-svn" (the default)
and git-svn will ignore the contents of the $GIT_DIR/git-svn directory
and instead do all of its work in $GIT_DIR/$GIT_SVN_ID for that
invocation.
invocation. The interface branch will be $GIT_SVN_ID-HEAD, instead of
git-svn-HEAD. Any $GIT_SVN_ID-HEAD branch should never be modified
by the user outside of git-svn commands.
ADDITIONAL FETCH ARGUMENTS
--------------------------