svn-fe: warn about experimental status
[git/git.git] / contrib / svn-fe / svn-fe.txt
CommitLineData
e605164d
JN
1svn-fe(1)
2=========
3
4NAME
5----
6svn-fe - convert an SVN "dumpfile" to a fast-import stream
7
8SYNOPSIS
9--------
10svnadmin dump --incremental REPO | svn-fe [url] | git fast-import
11
12DESCRIPTION
13-----------
14
d0fc40c7 15Converts a Subversion dumpfile into input suitable for
e605164d
JN
16git-fast-import(1) and similar importers. REPO is a path to a
17Subversion repository mirrored on the local disk. Remote Subversion
18repositories can be mirrored on local disk using the `svnsync`
19command.
20
75323459
JN
21Note: this tool is very young. The details of its commandline
22interface may change in backward incompatible ways.
23
e605164d
JN
24INPUT FORMAT
25------------
26Subversion's repository dump format is documented in full in
27`notes/dump-load-format.txt` from the Subversion source tree.
28Files in this format can be generated using the 'svnadmin dump' or
29'svk admin dump' command.
30
d0fc40c7
JN
31Dumps produced with 'svnadmin dump --deltas' (dumpfile format v3)
32are not supported.
33
e605164d
JN
34OUTPUT FORMAT
35-------------
36The fast-import format is documented by the git-fast-import(1)
37manual page.
38
39NOTES
40-----
41Subversion dumps do not record a separate author and committer for
42each revision, nor a separate display name and email address for
43each author. Like git-svn(1), 'svn-fe' will use the name
44
45---------
46user <user@UUID>
47---------
48
49as committer, where 'user' is the value of the `svn:author` property
50and 'UUID' the repository's identifier.
51
712308f2
JN
52To support incremental imports, 'svn-fe' puts a `git-svn-id` line at
53the end of each commit log message if passed an url on the command
54line. This line has the form `git-svn-id: URL@REVNO UUID`.
e605164d
JN
55
56The resulting repository will generally require further processing
57to put each project in its own repository and to separate the history
58of each branch. The 'git filter-branch --subdirectory-filter' command
59may be useful for this purpose.
60
61BUGS
62----
712308f2
JN
63Empty directories and unknown properties are silently discarded.
64
65The exit status does not reflect whether an error was detected.
e605164d
JN
66
67SEE ALSO
68--------
69git-svn(1), svn2git(1), svk(1), git-filter-branch(1), git-fast-import(1),
70https://svn.apache.org/repos/asf/subversion/trunk/notes/dump-load-format.txt