mirror of
https://github.com/frej/fast-export.git
synced 2026-03-03 16:50:42 +01:00
Use GitHub markdown
This commit is contained in:
39
README.md
39
README.md
@@ -1,24 +1,28 @@
|
||||
hg-fast-export.(sh|py) - mercurial to git converter using git-fast-import
|
||||
=========================================================================
|
||||
|
||||
Legal
|
||||
=====
|
||||
-----
|
||||
|
||||
Most hg-* scripts are licensed under the MIT license[0] and were written
|
||||
Most hg-* scripts are licensed under the [MIT license]
|
||||
(http://www.opensource.org/licenses/mit-license.php) and were written
|
||||
by Rocco Rutte <pdmef@gmx.net> with hints and help from the git list and
|
||||
#mercurial on freenode. hg-reset.py is licensed under GPLv2 since it
|
||||
\#mercurial on freenode. hg-reset.py is licensed under GPLv2 since it
|
||||
copies some code from the mercurial sources.
|
||||
|
||||
The current maintainer is Frej Drejhammar <frej.drejhammar@gmail.com>.
|
||||
|
||||
Usage
|
||||
=====
|
||||
-----
|
||||
|
||||
Using hg-fast-export is quite simple for a mercurial repository <repo>:
|
||||
|
||||
mkdir repo-git # or whatever
|
||||
cd repo-git
|
||||
git init
|
||||
hg-fast-export.sh -r <repo>
|
||||
```
|
||||
mkdir repo-git # or whatever
|
||||
cd repo-git
|
||||
git init
|
||||
hg-fast-export.sh -r <repo>
|
||||
```
|
||||
|
||||
Please note that hg-fast-export does not automatically check out the
|
||||
newly imported repository. You probably want to follow up the import
|
||||
@@ -29,7 +33,9 @@ Incremental imports to track hg repos is supported, too.
|
||||
Using hg-reset it is quite simple within a git repository that is
|
||||
hg-fast-export'ed from mercurial:
|
||||
|
||||
hg-reset.sh -R <revision>
|
||||
```
|
||||
hg-reset.sh -R <revision>
|
||||
```
|
||||
|
||||
will give hints on which branches need adjustment for starting over
|
||||
again.
|
||||
@@ -50,12 +56,14 @@ specified using the -A option. The file should contain lines of the
|
||||
form "FromAuthor=ToAuthor". The example authors.map below will
|
||||
translate "User <garbage<user@example.com>" to "User <user@example.com>".
|
||||
|
||||
```
|
||||
-- Start of authors.map --
|
||||
User <garbage<user@example.com>=User <user@example.com>
|
||||
-- End of authors.map --
|
||||
```
|
||||
|
||||
Tag and Branch Naming
|
||||
=====================
|
||||
---------------------
|
||||
|
||||
As Git and Mercurial have differ in what is a valid branch and tag
|
||||
name the -B and -T options allow a mapping file to be specified to
|
||||
@@ -63,7 +71,7 @@ rename branches and tags (respectively). The syntax of the mapping
|
||||
file is the same as for the author mapping.
|
||||
|
||||
Notes/Limitations
|
||||
=================
|
||||
-----------------
|
||||
|
||||
hg-fast-export supports multiple branches but only named branches with
|
||||
exactly one head each. Otherwise commits to the tip of these heads
|
||||
@@ -79,7 +87,7 @@ possible to use hg-fast-export on remote repositories
|
||||
(http/ssh). First clone the repository, then convert it.
|
||||
|
||||
Design
|
||||
======
|
||||
------
|
||||
|
||||
hg-fast-export.py was designed in a way that doesn't require a 2-pass
|
||||
mechanism or any prior repository analysis: if just feeds what it
|
||||
@@ -89,13 +97,8 @@ append-only storage model so that changesets hg-fast-export already
|
||||
saw never get modified.
|
||||
|
||||
Submitting Patches
|
||||
==================
|
||||
------------------
|
||||
|
||||
Please use the issue-tracker at github
|
||||
https://github.com/frej/fast-export to report bugs and submit
|
||||
patches.
|
||||
|
||||
Footnotes
|
||||
=========
|
||||
|
||||
[0] http://www.opensource.org/licenses/mit-license.php
|
||||
|
||||
Reference in New Issue
Block a user