@ -12,10 +12,8 @@ SYNOPSIS
DESCRIPTION
DESCRIPTION
-----------
-----------
git-svn is a simple conduit for changesets between a single Subversion
git-svn is a simple conduit for changesets between a single Subversion
branch and git.
branch and git. It is not to be confused with gitlink:git-svnimport[1].
They were designed with very different goals in mind.
git-svn is not to be confused with git-svnimport. The were designed
with very different goals in mind.
git-svn is designed for an individual developer who wants a
git-svn is designed for an individual developer who wants a
bidirectional flow of changesets between a single branch in Subversion
bidirectional flow of changesets between a single branch in Subversion
@ -34,26 +32,38 @@ git-svnimport is designed for.
COMMANDS
COMMANDS
--------
--------
init::
--
'init'::
Creates an empty git repository with additional metadata
Creates an empty git repository with additional metadata
directories for git-svn. The Subversion URL must be specified
directories for git-svn. The Subversion URL must be specified
as a command-line argument.
as a command-line argument.
fetch::
'fetch'::
Fetch unfetched revisions from the Subversion URL we are
tracking. refs/remotes/git-svn will be updated to the
Fetch unfetched revisions from the Subversion URL we are
latest revision.
tracking. refs/remotes/git-svn will be updated to the
latest revision.
Note: You should never attempt to modify the remotes/git-svn
branch outside of git-svn. Instead, create a branch from
remotes/git-svn and work on that branch. Use the 'commit'
command (see below) to write git commits back to
remotes/git-svn.
Note: You should never attempt to modify the remotes/git-svn
See '<<fetch-args,Additional Fetch Arguments>>' if you are interested in
branch outside of git-svn. Instead, create a branch from
manually joining branches on commit.
remotes/git-svn and work on that branch. Use the 'commit'
command (see below) to write git commits back to
remotes/git-svn.
See 'Additional Fetch Arguments' if you are interested in
'dcommit'::
manually joining branches on commit.
Commit all diffs from the current HEAD directly to the SVN
repository, and then rebase or reset (depending on whether or
not there is a diff between SVN and HEAD). It is recommended
that you run git-svn fetch and rebase (not pull) your commits
against the latest changes in the SVN repository.
This is advantageous over 'commit' (below) because it produces
cleaner, more linear history.
commit::
'commit'::
Commit specified commit or tree objects to SVN. This relies on
Commit specified commit or tree objects to SVN. This relies on
your imported fetch data being up-to-date. This makes
your imported fetch data being up-to-date. This makes
absolutely no attempts to do patching when committing to SVN, it
absolutely no attempts to do patching when committing to SVN, it
@ -61,9 +71,9 @@ commit::
commit. All merging is assumed to have taken place
commit. All merging is assumed to have taken place
independently of git-svn functions.
independently of git-svn functions.
rebuild::
'rebuild'::
Not a part of daily usage, but this is a useful command if
Not a part of daily usage, but this is a useful command if
you've just cloned a repository (using git-clone) that was
you've just cloned a repository (using gitlink:git-clone[1]) that was
tracked with git-svn. Unfortunately, git-clone does not clone
tracked with git-svn. Unfortunately, git-clone does not clone
git-svn metadata and the svn working tree that git-svn uses for
git-svn metadata and the svn working tree that git-svn uses for
its operations. This rebuilds the metadata so git-svn can
its operations. This rebuilds the metadata so git-svn can
@ -71,130 +81,170 @@ rebuild::
specified at the command-line if the directory/repository you're
specified at the command-line if the directory/repository you're
tracking has moved or changed protocols.
tracking has moved or changed protocols.
show-ignore::
'show-ignore'::
Recursively finds and lists the svn:ignore property on
Recursively finds and lists the svn:ignore property on
directories. The output is suitable for appending to
directories. The output is suitable for appending to
the $GIT_DIR/info/exclude file.
the $GIT_DIR/info/exclude file.
--
OPTIONS
OPTIONS
-------
-------
--
-r <ARG>::
-r <ARG>::
--revision <ARG>::
--revision <ARG>::
Only used with the 'fetch' command.
Takes any valid -r<argument> svn would accept and passes it
Only used with the 'fetch' command.
directly to svn. -r<ARG1>:<ARG2> ranges and "{" DATE "}" syntax
is also supported. This is passed directly to svn, see svn
Takes any valid -r<argument> svn would accept and passes it
documentation for more details.
directly to svn. -r<ARG1>:<ARG2> ranges and "{" DATE "}" syntax
is also supported. This is passed directly to svn, see svn
documentation for more details.
This can allow you to make partial mirrors when running fetch.
This can allow you to make partial mirrors when running fetch.
-::
-::
--stdin::
--stdin::
Only used with the 'commit' command.
Read a list of commits from stdin and commit them in reverse
Only used with the 'commit' command.
order. Only the leading sha1 is read from each line, so
git-rev-list --pretty=oneline output can be used.
Read a list of commits from stdin and commit them in reverse
order. Only the leading sha1 is read from each line, so
git-rev-list --pretty=oneline output can be used.
--rmdir::
--rmdir::
Only used with the 'commit' command.
Remove directories from the SVN tree if there are no files left
Only used with the 'commit' command.
behind. SVN can version empty directories, and they are not
removed by default if there are no files left in them. git
Remove directories from the SVN tree if there are no files left
cannot version empty directories. Enabling this flag will make
behind. SVN can version empty directories, and they are not
the commit to SVN act like git.
removed by default if there are no files left in them. git
cannot version empty directories. Enabling this flag will make
the commit to SVN act like git.
repo-config key: svn.rmdir
repo-config key: svn.rmdir
-e::
-e::
--edit::
--edit::
Only used with the 'commit' command.
Edit the commit message before committing to SVN. This is off by
Only used with the 'commit' command.
default for objects that are commits, and forced on when committing
tree objects.
repo-config key: svn.edit
Edit the commit message before committing to SVN. This is off by
default for objects that are commits, and forced on when committing
tree objects.
repo-config key: svn.edit
-l<num>::
-l<num>::
--find-copies-harder::
--find-copies-harder::
Both of these are only used with the 'commit' command.
They are both passed directly to git-diff-tree see
Both of these are only used with the 'commit' command.
git-diff-tree(1) for more information.
They are both passed directly to git-diff-tree see
gitlink:git-diff-tree[1] for more information.
repo-config key: svn.l
[verse]
repo-config key: svn.findcopiesharder
repo-config key: svn.l
repo-config key: svn.findcopiesharder
-A<filename>::
-A<filename>::
--authors-file=<filename>::
--authors-file=<filename>::
Syntax is compatible with the files used by git-svnimport and
Syntax is compatible with the files used by git-svnimport and
git-cvsimport:
git-cvsimport:
------------------------------------------------------------------------
------------------------------------------------------------------------
loginname = Joe User <user@example.com>
loginname = Joe User <user@example.com>
------------------------------------------------------------------------
------------------------------------------------------------------------
If this option is specified and git-svn encounters an SVN
If this option is specified and git-svn encounters an SVN
committer name that does not exist in the authors-file, git-svn
committer name that does not exist in the authors-file, git-svn
will abort operation. The user will then have to add the
will abort operation. The user will then have to add the
appropriate entry. Re-running the previous git-svn command
appropriate entry. Re-running the previous git-svn command
after the authors-file is modified should continue operation.
after the authors-file is modified should continue operation.
repo-config key: svn.authors-file
-m::
--merge::
-s<strategy>::
--strategy=<strategy>::
These are only used with the 'dcommit' command.
repo-config key: svn.authors-file
Passed directly to git-rebase when using 'dcommit' if a
'git-reset' cannot be used (see dcommit).
-n::
--dry-run::
This is only used with the 'dcommit' command.
Print out the series of git arguments that would show
which diffs would be committed to SVN.
--
ADVANCED OPTIONS
ADVANCED OPTIONS
----------------
----------------
--
-b<refname>::
-b<refname>::
--branch <refname>::
--branch <refname>::
Used with 'fetch' or 'commit'.
Used with 'fetch' or 'commit'.
This can be used to join arbitrary git branches to remotes/git-svn
This can be used to join arbitrary git branches to remotes/git-svn
on new commits where the tree object is equivalent.
on new commits where the tree object is equivalent.
When used with different GIT_SVN_ID values, tags and branches in
When used with different GIT_SVN_ID values, tags and branches in
SVN can be tracked this way, as can some merges where the heads
SVN can be tracked this way, as can some merges where the heads
end up having completely equivalent content. This can even be
end up having completely equivalent content. This can even be
used to track branches across multiple SVN _repositories_.
used to track branches across multiple SVN _repositories_.
This option may be specified multiple times, once for each
This option may be specified multiple times, once for each
branch.
branch.
repo-config key: svn.branch
repo-config key: svn.branch
-i<GIT_SVN_ID>::
-i<GIT_SVN_ID>::
--id <GIT_SVN_ID>::
--id <GIT_SVN_ID>::
This sets GIT_SVN_ID (instead of using the environment). See
the section on "Tracking Multiple Repositories or Branches" for
This sets GIT_SVN_ID (instead of using the environment). See the
more information on using GIT_SVN_ID.
section on
'<<tracking-multiple-repos,Tracking Multiple Repositories or Branches>>'
for more information on using GIT_SVN_ID.
--
COMPATIBILITY OPTIONS
COMPATIBILITY OPTIONS
---------------------
---------------------
--
--upgrade::
--upgrade::
Only used with the 'rebuild' command.
Only used with the 'rebuild' command.
Run this if you used an old version of git-svn that used
Run this if you used an old version of git-svn that used
"git-svn-HEAD" instead of "remotes/git-svn" as the branch
"git-svn-HEAD" instead of "remotes/git-svn" as the branch
for tracking the remote.
for tracking the remote.
--no-ignore-externals::
--no-ignore-externals::
Only used with the 'fetch' and 'rebuild' command.
Only used with the 'fetch' and 'rebuild' command.
By default, git-svn passes --ignore-externals to svn to avoid
fetching svn:external trees into git. Pass this flag to enable
externals tracking directly via git.
By default, git-svn passes --ignore-externals to svn to avoid
Versions of svn that do not support --ignore-externals are
fetching svn:external trees into git. Pass this flag to enable
automatically detected and this flag will be automatically
externals tracking directly via git.
enabled for them.
Versions of svn that do not support --ignore-externals are
Otherwise, do not enable this flag unless you know what you're
automatically detected and this flag will be automatically
doing.
enabled for them.
Otherwise, do not enable this flag unless you know what you're
repo-config key: svn.noignoreexternals
doing.
repo-config key: svn.noignoreexternals
--
Basic Examples
Basic Examples
~~~~~~~~~~~~~~
~~~~~~~~~~~~~~
@ -212,12 +262,26 @@ Tracking and contributing to an Subversion managed-project:
git-svn commit <tree-ish> [<tree-ish_2> ...]
git-svn commit <tree-ish> [<tree-ish_2> ...]
# Commit all the git commits from my-branch that don't exist in SVN:
# Commit all the git commits from my-branch that don't exist in SVN:
git-svn commit remotes/git-svn..my-branch
git-svn commit remotes/git-svn..my-branch
# Something is committed to SVN, pull the latest into your branch:
# Something is committed to SVN, rebase the latest into your branch:
git-svn fetch && git pull . remotes/git-svn
git-svn fetch && git rebase remotes/git-svn
# Append svn:ignore settings to the default git exclude file:
# Append svn:ignore settings to the default git exclude file:
git-svn show-ignore >> .git/info/exclude
git-svn show-ignore >> .git/info/exclude
------------------------------------------------------------------------
------------------------------------------------------------------------
REBASE VS. PULL
---------------
Originally, git-svn recommended that the remotes/git-svn branch be
pulled from. This is because the author favored 'git-svn commit B'
to commit a single head rather than the 'git-svn commit A..B' notation
to commit multiple commits.
If you use 'git-svn commit A..B' to commit several diffs and you do not
have the latest remotes/git-svn merged into my-branch, you should use
'git rebase' to update your work branch instead of 'git pull'. 'pull'
can cause non-linear history to be flattened when committing into SVN,
which can lead to merge commits reversing previous commits in SVN.
DESIGN PHILOSOPHY
DESIGN PHILOSOPHY
-----------------
-----------------
Merge tracking in Subversion is lacking and doing branched development
Merge tracking in Subversion is lacking and doing branched development
@ -226,6 +290,7 @@ any automated merge/branch tracking on the Subversion side and leaves it
entirely up to the user on the git side. It's simply not worth it to do
entirely up to the user on the git side. It's simply not worth it to do
a useful translation when the original signal is weak.
a useful translation when the original signal is weak.
[[tracking-multiple-repos]]
TRACKING MULTIPLE REPOSITORIES OR BRANCHES
TRACKING MULTIPLE REPOSITORIES OR BRANCHES
------------------------------------------
------------------------------------------
This is for advanced users, most users should ignore this section.
This is for advanced users, most users should ignore this section.
@ -241,6 +306,7 @@ invocation. The interface branch will be remotes/$GIT_SVN_ID, instead of
remotes/git-svn. Any remotes/$GIT_SVN_ID branch should never be modified
remotes/git-svn. Any remotes/$GIT_SVN_ID branch should never be modified
by the user outside of git-svn commands.
by the user outside of git-svn commands.
[[fetch-args]]
ADDITIONAL FETCH ARGUMENTS
ADDITIONAL FETCH ARGUMENTS
--------------------------
--------------------------
This is for advanced users, most users should ignore this section.
This is for advanced users, most users should ignore this section.
@ -251,11 +317,15 @@ optionally be specified in the form of sha1 hex sums at the
command-line. Unfetched SVN revisions may also be tied to particular
command-line. Unfetched SVN revisions may also be tied to particular
git commits with the following syntax:
git commits with the following syntax:
------------------------------------------------
svn_revision_number=git_commit_sha1
svn_revision_number=git_commit_sha1
------------------------------------------------
This allows you to tie unfetched SVN revision 375 to your current HEAD::
This allows you to tie unfetched SVN revision 375 to your current HEAD:
`git-svn fetch 375=$(git-rev-parse HEAD)`
------------------------------------------------
git-svn fetch 375=$(git-rev-parse HEAD)
------------------------------------------------
Advanced Example: Tracking a Reorganized Repository
Advanced Example: Tracking a Reorganized Repository
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -310,6 +380,10 @@ the possible corner cases (git doesn't do it, either). Renamed and
copied files are fully supported if they're similar enough for git to
copied files are fully supported if they're similar enough for git to
detect them.
detect them.
SEE ALSO
--------
gitlink:git-rebase[1]
Author
Author
------
------
Written by Eric Wong <normalperson@yhbt.net>.
Written by Eric Wong <normalperson@yhbt.net>.