Browse files

Start a README

  • Loading branch information...
1 parent 1311774 commit b5b64975c87731705de58bee3b30815fcd94defd @nominolo nominolo committed May 9, 2008
Showing with 47 additions and 0 deletions.
  1. +47 −0 README.markdown
View
47 README.markdown
@@ -0,0 +1,47 @@
+darcs-to-git
+ written by Steve Purcell, some improvements by Thomas Schilling
+
+Converts a Darcs repository into a Git repository. Supports
+incremental updates, i.e., you can pull new patches from the source
+repository or import a large repository in steps.
+
+USAGE
+=====
+
+(Use `darcs-to-git --help` to display the latest usage instructions.)
+
+1. Create an *empty* directory that will become the new git repository
+2. From inside that directory, run this program, passing the location
+ of the local source darcs repo as a parameter
+
+The program will git-init the empty directory, and migrate all patches
+in the source darcs repo into commits in that repository.
+
+Thereafter, incremental patch conversion from the same source repo is
+possible by repeating step 2.
+
+Options
+-------
+
+ * `--patches N`: only import `N` patches.
+
+ * `--email-address ADDRESS`: `darcs-to-git` tries to reconstruct the
+ email address from the darcs patch. In cases this is not possible,
+ a default will be picked by Git. This is usually the one in
+ `~/.gitconfig`. This option allows you to specify another default
+ (without having to to modify `~/.gitconfig.)
+
+ * `--list-authors`: Outputs a list of authors in the source
+ repository and how they will appear in the git repository and
+ quits. The output will be lines like this:
+
+ Jane@example.com: Jane <Jane@example.com>
+
+ This means that the darcs author "Jane@example.com" will be
+ translated to git-author "Jane" with email address
+ "Jane@example.com". You can use the output of this command as a
+ starting point for the input for `--author-map`.
+
+ * `--author-map FILENAME`: Allows translations from darcs committer
+ name to Git committer name. The input is a YAML map. For an
+ example see the output of `--author-map`.

0 comments on commit b5b6497

Please sign in to comment.