hg-fast-export.txt

   1 hg-fast-import.(sh|py) - mercurial to git converter using git-fast-import
   2
   3 Legal
   4 =====
   5
   6 Most hg-* scripts are licensed under the MIT license[0] and were written
   7 by Rocco Rutte <pdmef@gmx.net> with hints and help from the git list and
   8 #mercurial on freenode. hg-reset.py is licensed under GPLv2 since it
   9 copies some code from the mercurial sources.
  10
  11 The current maintainer is Frej Drejhammar <frej.drejhammar@gmail.com>.
  12
  13 Usage
  14 =====
  15
  16 Using hg-fast-export is quite simple for a mercurial repository <repo>:
  17
  18   mkdir repo-git # or whatever
  19   cd repo-git
  20   git init
  21   hg-fast-import.sh -r <repo>
  22
  23 Incremental imports to track hg repos is supported, too.
  24
  25 Using hg-reset it is quite simple within a git repository that is
  26 hg-fast-export'ed from mercurial:
  27
  28   hg-reset.sh -R <revision>
  29
  30 will give hints on which branches need adjustment for starting over
  31 again.
  32
  33 Notes/Limitations
  34 =================
  35
  36 hg-fast-import supports multiple branches but only named branches with exaclty
  37 one head each. Otherwise commits to the tip of these heads within branch
  38 will get flattened into merge commits.
  39
  40 As each git-fast-import run creates a new pack file, it may be required
  41 to repack the repository quite often for incremental imports (especially
  42 when importing a small number of changesets per incremental import).
  43
  44 Design
  45 ======
  46
  47 hg-fast-import.py was designed in a way that doesn't require a 2-pass mechanism
  48 or any prior repository analysis: if just feeds what it finds into
  49 git-fast-import. This also implies that it heavily relies on strictly
  50 linear ordering of changesets from hg, i.e. its append-only storage
  51 model so that changesets hg-fast-import already saw never get modified.
  52
  53 Todo
  54 ====
  55
  56 For incremental imports, handling tags needs to be reworked (maybe):
  57 Right now we assume that once a tag is created, it stays forever and
  58 never changes. However,
  59
  60   1) tags in hg may be removed
  61   2) tags may change
  62
  63 I'm not yet sure how to handle this and how this interferes with
  64 non-hg-based tags in git.
  65
  66 The same for branches: They may get removed.
  67
  68 For one-time conversions, everything is fine.
  69
  70 Footnotes
  71 =========
  72
  73 [0] http://www.opensource.org/licenses/mit-license.php