Skip to content

Commit

Permalink
contrib/git-svn: tell the user to not modify git-svn-HEAD directly
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Eric Wong authored and Junio C Hamano committed Feb 27, 2006
1 parent c447f10 commit b705ba4
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion contrib/git-svn/git-svn.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
--------------------------
Expand Down

0 comments on commit b705ba4

Please sign in to comment.