descriptionPrograms to feed git-fast-import
ownerfrej.drejhammar@gmail.com
last changeThu, 7 May 2020 18:10:24 +0000 (7 20:10 +0200)
content tags
add:
README.md

hg-fast-export.(sh|py) - mercurial to git converter using git-fast-import

Most hg-* scripts are licensed under the MIT license 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 copies some code from the mercurial sources.

The current maintainer is Frej Drejhammar <frej.drejhammar@gmail.com>.

Support

If you have problems with hg-fast-export or have found a bug, please create an issue at the github issue tracker. Before creating a new issue, check that your problem has not already been addressed in an already closed issue. Do not contact the maintainer directly unless you want to report a security bug. That way the next person having the same problem can benefit from the time spent solving the problem the first time.

System Requirements

This project depends on Python 2.7 or 3.5+, and the Mercurial >= 4.6 package (>= 5.2, if Python 3.5+). If Python is not installed, install it before proceeding. TheMercurial package can be installed with pip install mercurial.

On windows the bash that comes with "Git for Windows" is known to work well.

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 <local-repo>
git checkout HEAD

Please note that hg-fast-export does not automatically check out the newly imported repository. You probably want to follow up the import with a git checkout-command.

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>

will give hints on which branches need adjustment for starting over again.

When a mercurial repository does not use utf-8 for encoding author strings and commit messages the -e <encoding> command line option can be used to force fast-export to convert incoming meta data from <encoding> to utf-8. This encoding option is also applied to file names.

In some locales Mercurial uses different encodings for commit messages and file names. In that case, you can use --fe <encoding> command line option which overrides the -e option for file names.

As mercurial appears to be much less picky about the syntax of the author information than git, an author mapping file can be given to hg-fast-export to fix up malformed author strings. The file is specified using the -A option. The file should contain lines of the form "<key>"="<value>". Inside the key and value strings, all escape sequences understood by the python unicode_escape encoding are supported; strings are otherwise assumed to be UTF8-encoded. (Versions of fast-export prior to v171002 had a different syntax, the old syntax can be enabled by the flag --mappings-are-raw.)

The example authors.map below will translate User <garbage<tab><user@example.com> to User <user@example.com>.

-- Start of authors.map --
"User <garbage\t<user@example.com>"="User <user@example.com>"
-- End of authors.map --

If you have many Mercurial repositories, Chris J Billington's hg-export-tool allows you to batch convert them.

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 rename branches and tags (respectively). The syntax of the mapping file is the same as for the author mapping.

When the -B and -T flags are used, you will probably want to use the -n flag to disable the built-in (broken in many cases) sanitizing of branch/tag names. In the future -n will become the default, but in order to not break existing incremental conversions, the default remains with the old behavior.

By default, the default mercurial branch is renamed to the master branch on git. If your mercurial repo contains both default and master branches, you'll need to override this behavior. Use -M <newName> to specify what name to give the default branch.

Content filtering

hg-fast-export supports filtering the content of exported files. The filter is supplied to the --filter-contents option. hg-fast-export runs the filter for each exported file, pipes its content to the filter's standard input, and uses the filter's standard output in place of the file's original content. The prototypical use of this feature is to convert line endings in text files from CRLF to git's preferred LF:

-- Start of crlf-filter.sh --
#!/bin/sh
# $1 = pathname of exported file relative to the root of the repo
# $2 = Mercurial's hash of the file
# $3 = "1" if Mercurial reports the file as binary, otherwise "0"

if [ "$3" == "1" ]; then cat; else dos2unix; fi
-- End of crlf-filter.sh --

Plugins

hg-fast-export supports plugins to manipulate the file data and commit metadata. The plugins are enabled with the --plugin option. The value of said option is a plugin name (by folder in the plugins directory), and optionally, and equals-sign followed by an initialization string.

There is a readme accompanying each of the bundled plugins, with a description of the usage. To create a new plugin, one must simply add a new folder under the plugins directory, with the name of the new plugin. Inside, there must be an __init__.py file, which contains at a minimum:

def build_filter(args):
    return Filter(args)

class Filter:
    def __init__(self, args):
        pass
        #Or don't pass, if you want to do some init code here

Beyond the boilerplate initialization, you can see the two different defined filter methods in the dos2unix and branch_name_in_commit plugins.

commit_data = {'branch': branch, 'parents': parents, 'author': author, 'desc': desc}

def commit_message_filter(self,commit_data):

The commit_message_filter method is called for each commit, after parsing from hg, but before outputting to git. The dictionary commit_data contains the above attributes about the commit, and can be modified by any filter. The values in the dictionary after filters have been run are used to create the git commit.

file_data = {'filename':filename,'file_ctx':file_ctx,'d':d}

def file_data_filter(self,file_data):

The file_data_filter method is called for each file within each commit. The dictionary file_data contains the above attributes about the file, and can be modified by any filter. file_ctx is the filecontext from the mercurial python library. After all filters have been run, the values are used to add the file to the git commit.

Submodules

See README-SUBMODULES.md for how to convert subrepositories into git submodules.

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 within the branch will get flattened into merge commits. Chris J Billington's hg-export-tool can help you to handle branches with duplicate heads.

hg-fast-export will ignore any files or directories tracked by mercurial called .git, and will print a warning if it encounters one. Git cannot track such files or directories. This is not to be confused with submodules, which are described in README-SUBMODULES.md.

As each git-fast-import run creates a new pack file, it may be required to repack the repository quite often for incremental imports (especially when importing a small number of changesets per incremental import).

The way the hg API and remote access protocol is designed it is not 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 finds into git-fast-import. This also implies that it heavily relies on strictly linear ordering of changesets from hg, i.e. its append-only storage model so that changesets hg-fast-export already saw never get modified.

Submitting Patches

Please use the issue-tracker at github to report bugs and submit patches.

Please read https://chris.beams.io/posts/git-commit/ on how to write a good commit message before submitting a pull request for review. Although the article recommends at most 50 characters for the subject, up to 72 characters are frequently accepted for fast-export.

Frequent Problems

shortlog
2020-05-07 Frej DrejhammarMerge branch 'PR/226'master
2020-05-06 chrisjbillingtonFix backward incompatible change for hg < 5.1
2020-05-06 Frej DrejhammarMerge branch 'PR/223'
2020-05-06 Ondrej StanekAllow converting a repository with git and hg subrepos
2020-03-26 Frej DrejhammarMerge branch 'PR/217'
2020-03-25 chrisjbillingtonAllow utf8 in mappings
2020-03-25 Frej DrejhammarMerge branch 'PR/214'
2020-03-25 Toni SissalaFix TypeError when using -M command line argument
2020-03-10 Frej DrejhammarMerge branch 'PR/211'
2020-03-09 Pi DelportFix link markup for hg-export-tool
2020-03-08 Frej DrejhammarMerge branch 'PR/210'
2020-03-08 chrisjbillingtonFix bug in ignoring .git files/folders on Windows
2020-03-06 Frej DrejhammarMerge branch 'PR/209'
2020-03-06 chrisjbillingtonFix failure to print error message in verify_heads
2020-03-01 Frej DrejhammarMerge branch 'PR/208'
2020-02-29 Max FuquaResolve type error resulting from passing an int to...
...
tags
3 months ago v200213 v200213
8 months ago v190913 v190913
16 months ago v190107 v190107
23 months ago v180610 v180610
2 years ago v180317 v180317
2 years ago v180126 v180126
2 years ago v171002 v171002
2 years ago v170826 v170826
2 years ago v170818 v170818
2 years ago v170624 v170624
2 years ago v170617 v170617
2 years ago v170604 v170604
3 years ago v170101 v170101
3 years ago v160914 v160914
3 years ago v160415 Tag version 160415
heads
3 weeks ago master
12 years ago git-p4
forks
Cached version (5585s old)
 source.codes 
fast-export/rorcz.git Local repo.or.cz fork with needed fixes mackyle@gmail.com 3 years ago
fast-export/benizi.git repo.or.cz@benizi.com 8 years ago
fast-export/fast-export-unix-compliant.git dereckson@espace... 8 years ago
fast-export/dharding.git dharding@gmail.com 8 years ago
fast-export/barak.git tweaks and maybe debian packaging info barak@cs.nuim.ie 8 years ago