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