Change syntax of mapping files
[fast-export.git] / README.md
blobe09b271ce0f345a6afcd99b775f1c089b9edf1af
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 Usage
28 -----
30 Using hg-fast-export is quite simple for a mercurial repository <repo>:
32 ```
33 mkdir repo-git # or whatever
34 cd repo-git
35 git init
36 hg-fast-export.sh -r <repo>
37 ```
39 Please note that hg-fast-export does not automatically check out the
40 newly imported repository. You probably want to follow up the import
41 with a `git checkout`-command.
43 Incremental imports to track hg repos is supported, too.
45 Using hg-reset it is quite simple within a git repository that is
46 hg-fast-export'ed from mercurial:
48 ```
49 hg-reset.sh -R <revision>
50 ```
52 will give hints on which branches need adjustment for starting over
53 again.
55 When a mercurial repository does not use utf-8 for encoding author
56 strings and commit messages the `-e <encoding>` command line option
57 can be used to force fast-export to convert incoming meta data from
58 <encoding> to utf-8. This encoding option is also applied to file names.
60 In some locales Mercurial uses different encodings for commit messages
61 and file names. In that case, you can use `--fe <encoding>` command line
62 option which overrides the -e option for file names.
64 As mercurial appears to be much less picky about the syntax of the
65 author information than git, an author mapping file can be given to
66 hg-fast-export to fix up malformed author strings. The file is
67 specified using the -A option. The file should contain lines of the
68 form `"<key>"="<value>"`. Inside the key and value strings, all escape
69 sequences understood by the python `string_escape` encoding are
70 supported. (Versions of fast-export prior to v171002 had a different
71 syntax, the old syntax can be enabled by the flag
72 `--mappings-are-raw`.)
74 The example authors.map below will translate `User
75 <garbage<tab><user@example.com>` to `User <user@example.com>`.
77 ```
78 -- Start of authors.map --
79 "User <garbage\t<user@example.com>"="User <user@example.com>"
80 -- End of authors.map --
81 ```
83 Tag and Branch Naming
84 ---------------------
86 As Git and Mercurial have differ in what is a valid branch and tag
87 name the -B and -T options allow a mapping file to be specified to
88 rename branches and tags (respectively). The syntax of the mapping
89 file is the same as for the author mapping.
91 Notes/Limitations
92 -----------------
94 hg-fast-export supports multiple branches but only named branches with
95 exactly one head each. Otherwise commits to the tip of these heads
96 within the branch will get flattened into merge commits.
98 As each git-fast-import run creates a new pack file, it may be
99 required to repack the repository quite often for incremental imports
100 (especially when importing a small number of changesets per
101 incremental import).
103 The way the hg API and remote access protocol is designed it is not
104 possible to use hg-fast-export on remote repositories
105 (http/ssh). First clone the repository, then convert it.
107 Design
108 ------
110 hg-fast-export.py was designed in a way that doesn't require a 2-pass
111 mechanism or any prior repository analysis: if just feeds what it
112 finds into git-fast-import. This also implies that it heavily relies
113 on strictly linear ordering of changesets from hg, i.e. its
114 append-only storage model so that changesets hg-fast-export already
115 saw never get modified.
117 Submitting Patches
118 ------------------
120 Please use the issue-tracker at github
121 https://github.com/frej/fast-export to report bugs and submit
122 patches.