[PATCH svn-dump-fast-export] Reference documentation

[PATCH svn-dump-fast-export] Reference documentation

[Jonathan Nieder]

Add a simple manual page (in asciidoc format) to document
the svn-fe command.

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
Patch is against git://github.com/barrbrain/svn-dump-fast-export.git master

Thoughts?

 svn-fe.txt |   56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 56 insertions(+), 0 deletions(-)
 create mode 100644 svn-fe.txt

diff --git a/svn-fe.txt b/svn-fe.txt
new file mode 100644
index 0000000..bfd3a68
--- /dev/null
+++ b/svn-fe.txt
@@ -0,0 +1,56 @@
+svn-fe(1)
+=========
+
+NAME
+----
+svn-fe - convert an SVN "dumpfile" to a fast-import stream
+
+SYNOPSIS
+--------
+svnadmin dump --incremental REPO | svn-fe [url] | git fast-import
+
+DESCRIPTION
+-----------
+Converts a textual representation of a Subversion repository into
+input suitable for git-fast-import(1) and similar importers.
+
+INPUT FORMAT
+------------
+Subversion's repository dump format is documented in full in
+`notes/dump-load-format.txt` from the Subversion source tree.
+Files in this format can be generated using the 'svnadmin dump' or
+'svk admin dump' command.
+
+OUTPUT FORMAT
+-------------
+The fast-import format is documented by the git-fast-import(1)
+manual page.
+
+NOTES
+-----
+Subversion dumps do not record a separate author and committer for
+each revision, nor a separate display name and email address for
+each author.  Like git-svn(1), 'svn-fe' will use the name
+
+---------
+user <user@UUID>
+---------
+
+as committer, where 'user' is the value of the `svn:author` property
+and 'UUID' the repository's identifier.
+
+To support incremental imports, 'svn-fe' will put a `git-svn-id`
+line at the end of each commit log message if passed an url on the
+command line.  This line has the form `git-svn-id: URL@REVNO UUID`.
+
+Empty directories and unknown properties are silently discarded.
+
+The resulting repository will generally require further processing
+to put each project in its own repository and to separate the history
+of each branch.  The 'git filter-branch --subdirectory-filter' command
+may be useful for this purpose.
+
+SEE ALSO
+--------
+git-svn(1), svn2git(1), svk(1), git-filter-branch(1), git-fast-import(1),
+https://svn.apache.org/repos/asf/subversion/trunk/notes/dump-load-format.txt
-- 
1.7.1

Re: [PATCH svn-dump-fast-export] Reference documentation

[David Michael Barr]

Hi,

> Add a simple manual page (in asciidoc format) to document
> the svn-fe command.
> 
> Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
> ---
> Patch is against git://github.com/barrbrain/svn-dump-fast-export.git master

This patch has now been accepted into that repository.

> Thoughts?

Couldn't have done it better myself.

Incremental dump support is still a TODO.

--
David Barr