Merge branch 'atykhyy-as-binary'
[fast-export.git] / README.md
blob32192403d993da44f8b82fa4a6e16e12a5bed636
1 hg-fast-export.(sh|py) - mercurial to git converter using git-fast-import
2 =========================================================================
4 Legal
5 -----
7 Most hg-* scripts are licensed under the [MIT license]
8 (http://www.opensource.org/licenses/mit-license.php) and were written
9 by Rocco Rutte <pdmef@gmx.net> with hints and help from the git list and
10 \#mercurial on freenode. hg-reset.py is licensed under GPLv2 since it
11 copies some code from the mercurial sources.
13 The current maintainer is Frej Drejhammar <frej.drejhammar@gmail.com>.
15 Support
16 -------
18 If you have problems with hg-fast-export or have found a bug, please
19 create an issue at the [github issue tracker]
20 (https://github.com/frej/fast-export/issues). Before creating a new
21 issue, check that your problem has not already been addressed in an
22 already closed issue. Do not contact the maintainer directly unless
23 you want to report a security bug. That way the next person having the
24 same problem can benefit from the time spent solving the problem the
25 first time.
27 System Requirements
28 -------------------
30 This project depends on Python 2.7 and the Mercurial 4.6 package. If
31 Python is not installed, install it before proceeding. The Mercurial
32 package can be installed with `pip install mercurial`.
34 If you're on Windows, run the following commands in git bash (Git for
35 Windows).
37 Usage
38 -----
40 Using hg-fast-export is quite simple for a mercurial repository <repo>:
42 ```
43 mkdir repo-git # or whatever
44 cd repo-git
45 git init
46 hg-fast-export.sh -r <local-repo>
47 git checkout HEAD
48 ```
50 Please note that hg-fast-export does not automatically check out the
51 newly imported repository. You probably want to follow up the import
52 with a `git checkout`-command.
54 Incremental imports to track hg repos is supported, too.
56 Using hg-reset it is quite simple within a git repository that is
57 hg-fast-export'ed from mercurial:
59 ```
60 hg-reset.sh -R <revision>
61 ```
63 will give hints on which branches need adjustment for starting over
64 again.
66 When a mercurial repository does not use utf-8 for encoding author
67 strings and commit messages the `-e <encoding>` command line option
68 can be used to force fast-export to convert incoming meta data from
69 <encoding> to utf-8. This encoding option is also applied to file names.
71 In some locales Mercurial uses different encodings for commit messages
72 and file names. In that case, you can use `--fe <encoding>` command line
73 option which overrides the -e option for file names.
75 As mercurial appears to be much less picky about the syntax of the
76 author information than git, an author mapping file can be given to
77 hg-fast-export to fix up malformed author strings. The file is
78 specified using the -A option. The file should contain lines of the
79 form `"<key>"="<value>"`. Inside the key and value strings, all escape
80 sequences understood by the python `string_escape` encoding are
81 supported. (Versions of fast-export prior to v171002 had a different
82 syntax, the old syntax can be enabled by the flag
83 `--mappings-are-raw`.)
85 The example authors.map below will translate `User
86 <garbage<tab><user@example.com>` to `User <user@example.com>`.
88 ```
89 -- Start of authors.map --
90 "User <garbage\t<user@example.com>"="User <user@example.com>"
91 -- End of authors.map --
92 ```
94 Tag and Branch Naming
95 ---------------------
97 As Git and Mercurial have differ in what is a valid branch and tag
98 name the -B and -T options allow a mapping file to be specified to
99 rename branches and tags (respectively). The syntax of the mapping
100 file is the same as for the author mapping.
102 Content filtering
103 -----------------
105 hg-fast-export supports filtering the content of exported files.
106 The filter is supplied to the --filter-contents option. hg-fast-export
107 runs the filter for each exported file, pipes its content to the filter's
108 standard input, and uses the filter's standard output in place
109 of the file's original content. The prototypical use of this feature
110 is to convert line endings in text files from CRLF to git's preferred LF:
113 -- Start of crlf-filter.sh --
114 #!/bin/sh
115 # $1 = pathname of exported file relative to the root of the repo
116 # $2 = Mercurial's hash of the file
117 # $3 = "1" if Mercurial reports the file as binary, otherwise "0"
119 if [ "$3" == "1" ]; then cat; else dos2unix; fi
120 -- End of crlf-filter.sh --
123 Notes/Limitations
124 -----------------
126 hg-fast-export supports multiple branches but only named branches with
127 exactly one head each. Otherwise commits to the tip of these heads
128 within the branch will get flattened into merge commits.
130 As each git-fast-import run creates a new pack file, it may be
131 required to repack the repository quite often for incremental imports
132 (especially when importing a small number of changesets per
133 incremental import).
135 The way the hg API and remote access protocol is designed it is not
136 possible to use hg-fast-export on remote repositories
137 (http/ssh). First clone the repository, then convert it.
139 Design
140 ------
142 hg-fast-export.py was designed in a way that doesn't require a 2-pass
143 mechanism or any prior repository analysis: if just feeds what it
144 finds into git-fast-import. This also implies that it heavily relies
145 on strictly linear ordering of changesets from hg, i.e. its
146 append-only storage model so that changesets hg-fast-export already
147 saw never get modified.
149 Submitting Patches
150 ------------------
152 Please use the issue-tracker at github
153 https://github.com/frej/fast-export to report bugs and submit
154 patches.