Mercurial > hg > hg-fastimport

annotate README.txt @ 69:4954b4f1faab

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Mercurial 1.6 is no longer supported. At any rate, it doesn't work with Mercurial 1.9 unless you use OS packages, and that breaks 1.6. So drop 1.6.
author Greg Ward <greg@gerg.ca>
date Sun, 26 Jul 2015 18:05:44 -0400
parents d88ce26e0946
children a739b8dc8e6f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
1 hg-fastimport
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
2 -------------
5
ba7e6a39bf90 Add a README and the GPL
Paul Crowley <paul@lshift.net>
parents:
diff changeset
3
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
4 WARNING: this extension is incomplete and lightly tested. It is
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
5 currently intended for Mercurial developers or particularly daring
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
6 users.
5
ba7e6a39bf90 Add a README and the GPL
Paul Crowley <paul@lshift.net>
parents:
diff changeset
7
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
8 hg-fastimport is a Mercurial extension for importing Git's fast-import
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
9 dumps into Mercurial. fast-import is a file format for representing the
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
10 entire history of a version control repository.
5
ba7e6a39bf90 Add a README and the GPL
Paul Crowley <paul@lshift.net>
parents:
diff changeset
11
6
0185a9b236eb Line wrap README
Paul Crowley <paul@lshift.net>
parents: 5
diff changeset
12 This file format was designed to make it easier to write tools which
51
d3ae32b7f282 README: misc updates
Greg Ward <greg-hg@gerg.ca>
parents: 35
diff changeset
13 convert from foreign (non-Git) VCS repository formats into Git; such
d3ae32b7f282 README: misc updates
Greg Ward <greg-hg@gerg.ca>
parents: 35
diff changeset
14 tools exist for CVS, Mercurial, Darcs, and Perforce.
5
ba7e6a39bf90 Add a README and the GPL
Paul Crowley <paul@lshift.net>
parents:
diff changeset
15
8
b2ee2f810f1e and fix the wording again
Paul Crowley <paul@lshift.net>
parents: 7
diff changeset
16 However, there's no reason Git should be the only VCS to read
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
17 git-fast-import files; for example, Bazaar has a fastimport extension
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
18 similar in scope and aim to hg-fastimport. (In fact, hg-fastimport
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
19 draws heavily on the work done for bzr-fastimport.)
5
ba7e6a39bf90 Add a README and the GPL
Paul Crowley <paul@lshift.net>
parents:
diff changeset
20
51
d3ae32b7f282 README: misc updates
Greg Ward <greg-hg@gerg.ca>
parents: 35
diff changeset
21 The goal of hg-fastimport is to make it just as easy to populate a
d3ae32b7f282 README: misc updates
Greg Ward <greg-hg@gerg.ca>
parents: 35
diff changeset
22 Mercurial repository from a fastimport dump as it is for Bazaar or Git.
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
23
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
24
35
233040cea97a Update README.txt to reflect new dependency on pyfastimport.
Greg Ward <greg-hg@gerg.ca>
parents: 33
diff changeset
25 DEPENDENCIES
233040cea97a Update README.txt to reflect new dependency on pyfastimport.
Greg Ward <greg-hg@gerg.ca>
parents: 33
diff changeset
26 ------------
233040cea97a Update README.txt to reflect new dependency on pyfastimport.
Greg Ward <greg-hg@gerg.ca>
parents: 33
diff changeset
27
67
d88ce26e0946 README: improve dependency instructions.
Greg Ward <greg@gerg.ca>
parents: 63
diff changeset
28 hg-fastimport depends on:
d88ce26e0946 README: improve dependency instructions.
Greg Ward <greg@gerg.ca>
parents: 63
diff changeset
29
69
4954b4f1faab Mercurial 1.6 is no longer supported.
Greg Ward <greg@gerg.ca>
parents: 67
diff changeset
30 * Mercurial 1.7 or 1.8
67
d88ce26e0946 README: improve dependency instructions.
Greg Ward <greg@gerg.ca>
parents: 63
diff changeset
31 * python-fastimport
51
d3ae32b7f282 README: misc updates
Greg Ward <greg-hg@gerg.ca>
parents: 35
diff changeset
32
67
d88ce26e0946 README: improve dependency instructions.
Greg Ward <greg@gerg.ca>
parents: 63
diff changeset
33 The easiest way to get python-fastimport to use OS packages. E.g. for
d88ce26e0946 README: improve dependency instructions.
Greg Ward <greg@gerg.ca>
parents: 63
diff changeset
34 Debian and Ubuntu:
35
233040cea97a Update README.txt to reflect new dependency on pyfastimport.
Greg Ward <greg-hg@gerg.ca>
parents: 33
diff changeset
35
67
d88ce26e0946 README: improve dependency instructions.
Greg Ward <greg@gerg.ca>
parents: 63
diff changeset
36 sudo aptitude install python-fastimport
35
233040cea97a Update README.txt to reflect new dependency on pyfastimport.
Greg Ward <greg-hg@gerg.ca>
parents: 33
diff changeset
37
67
d88ce26e0946 README: improve dependency instructions.
Greg Ward <greg@gerg.ca>
parents: 63
diff changeset
38 Likewise for Fedora:
35
233040cea97a Update README.txt to reflect new dependency on pyfastimport.
Greg Ward <greg-hg@gerg.ca>
parents: 33
diff changeset
39
67
d88ce26e0946 README: improve dependency instructions.
Greg Ward <greg@gerg.ca>
parents: 63
diff changeset
40 sudo yum install python-fastimport
d88ce26e0946 README: improve dependency instructions.
Greg Ward <greg@gerg.ca>
parents: 63
diff changeset
41
d88ce26e0946 README: improve dependency instructions.
Greg Ward <greg@gerg.ca>
parents: 63
diff changeset
42 On other operating systems, you can install from PyPI:
35
233040cea97a Update README.txt to reflect new dependency on pyfastimport.
Greg Ward <greg-hg@gerg.ca>
parents: 33
diff changeset
43
67
d88ce26e0946 README: improve dependency instructions.
Greg Ward <greg@gerg.ca>
parents: 63
diff changeset
44 pip install fastimport
35
233040cea97a Update README.txt to reflect new dependency on pyfastimport.
Greg Ward <greg-hg@gerg.ca>
parents: 33
diff changeset
45
67
d88ce26e0946 README: improve dependency instructions.
Greg Ward <greg@gerg.ca>
parents: 63
diff changeset
46 If all else fails, you can find the source for python-fastimport here:
61
a1558739bd5e Update README to reference lp:python-fastimport rather than Greg's pyfastimport.
Jelmer Vernooij <jelmer@samba.org>
parents: 51
diff changeset
47
67
d88ce26e0946 README: improve dependency instructions.
Greg Ward <greg@gerg.ca>
parents: 63
diff changeset
48 https://github.com/jelmer/python-fastimport
35
233040cea97a Update README.txt to reflect new dependency on pyfastimport.
Greg Ward <greg-hg@gerg.ca>
parents: 33
diff changeset
49
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
50 USAGE
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
51 -----
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
52
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
53 To use hg-fastimport, add a line like
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
54
33
31b9a5805f02 Rename the extension's package from 'fastimport' to 'hgfastimport'.
Greg Ward <greg-hg@gerg.ca>
parents: 30
diff changeset
55 fastimport = /path/to/hg-fastimport/hgfastimport
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
56
67
d88ce26e0946 README: improve dependency instructions.
Greg Ward <greg@gerg.ca>
parents: 63
diff changeset
57 to the [extensions] section of your hgrc. Don't forget to install
d88ce26e0946 README: improve dependency instructions.
Greg Ward <greg@gerg.ca>
parents: 63
diff changeset
58 python-fastimport as explained above.
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
59
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
60 To import into a brand-new Mercurial repository:
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
61
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
62 hg init new
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
63 hg -R new fastimport FILE...
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
64
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
65 where FILE... is a list of one or more fast-import dumps.
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
66
5
ba7e6a39bf90 Add a README and the GPL
Paul Crowley <paul@lshift.net>
parents:
diff changeset
67
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
68 TESTING
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
69 -------
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
70
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
71 hg-fastimport uses Mercurial's own testing infrastructure, so you will
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
72 need a copy of the Mercurial source handy. For example, I keep a clone
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
73 of Mercurial "crew" in ~/src/hg-crew. To test hg-fastimport:
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
74
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
75 cd tests
51
d3ae32b7f282 README: misc updates
Greg Ward <greg-hg@gerg.ca>
parents: 35
diff changeset
76 ~/src/hg-crew/tests/run-tests.py --local
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
77
5
ba7e6a39bf90 Add a README and the GPL
Paul Crowley <paul@lshift.net>
parents:
diff changeset
78
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
79 FURTHER READING
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
80 ---------------
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
81
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
82 The fast-import format is documented in the git-fast-import(1) man page:
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
83
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
84 http://www.kernel.org/pub/software/scm/git-core/docs/git-fast-import.html
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
85
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
86 Tools to convert various version control repositories to
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
87 fast-import format:
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
88
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
89 http://cvs2svn.tigris.org/cvs2git.html (CVS)
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
90 http://repo.or.cz/w/fast-export.git (Mercurial, Subversion)
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
91 http://repo.or.cz/w/darcs2git.git (Darcs)
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
92
5
ba7e6a39bf90 Add a README and the GPL
Paul Crowley <paul@lshift.net>
parents:
diff changeset
93
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
94 AVAILABILITY
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
95 ------------
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
96
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
97 You can get the latest copy of hg-fastimport from its public Mercurial
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
98 repository:
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
99
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
100 hg clone http://vc.gerg.ca/hg/hg-fastimport
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
101
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
102
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
103 AUTHORS
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
104 -------
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
105
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
106 original author:
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
107 Paul Crowley <paul at lshift dot net>
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
108 LShift Ltd
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
109
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
110 derived from bzr-fastimport by:
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
111 Ian Clatworthy <ian.clatworthy at internode dot on dot net>
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
112 Canonical Ltd
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
113
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
114 current maintainer:
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
115 Greg Ward <greg-hg at gerg dot ca>
5
ba7e6a39bf90 Add a README and the GPL
Paul Crowley <paul@lshift.net>
parents:
diff changeset
116
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
117 contributors:
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
118 Paul Aurich <paul at darkrain42 dot org>
63
280eb5061a5e Add myself to contributors list.
Jelmer Vernooij <jelmer@samba.org>
parents: 61
diff changeset
119 Jelmer Vernooij <jelmer at samba dot org>
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
120
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
121
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
122 COPYRIGHT
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
123 ---------
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
124
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
125 Copyright (C) 2008 Canonical Ltd
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
126 Copyright (C) 2008 LShift Ltd.
5
ba7e6a39bf90 Add a README and the GPL
Paul Crowley <paul@lshift.net>
parents:
diff changeset
127
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
128 This program is free software; you can redistribute it and/or modify
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
129 it under the terms of the GNU General Public License as published by
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
130 the Free Software Foundation; either version 2 of the License, or
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
131 (at your option) any later version.
5
ba7e6a39bf90 Add a README and the GPL
Paul Crowley <paul@lshift.net>
parents:
diff changeset
132
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
133 This program is distributed in the hope that it will be useful,
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
134 but WITHOUT ANY WARRANTY; without even the implied warranty of
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
135 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
136 GNU General Public License for more details.
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
137
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
138 You should have received a copy of the GNU General Public License along
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
139 with this program; if not, write to the Free Software Foundation, Inc.,
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
140 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.