Mercurial > hg > hg-fastimport

annotate README.txt @ 61:a1558739bd5e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update README to reference lp:python-fastimport rather than Greg's pyfastimport.
author Jelmer Vernooij <jelmer@samba.org>
date Thu, 10 Nov 2011 23:02:14 +0100
parents d3ae32b7f282
children 280eb5061a5e
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
51
d3ae32b7f282 README: misc updates
Greg Ward <greg-hg@gerg.ca>
parents: 35
diff changeset
28 hg-fastimport requires Mercurial 1.3.
d3ae32b7f282 README: misc updates
Greg Ward <greg-hg@gerg.ca>
parents: 35
diff changeset
29
61
a1558739bd5e Update README to reference lp:python-fastimport rather than Greg's pyfastimport.
Jelmer Vernooij <jelmer@samba.org>
parents: 51
diff changeset
30 hg-fastimport depends on the python-fastimport library (which was extracted
a1558739bd5e Update README to reference lp:python-fastimport rather than Greg's pyfastimport.
Jelmer Vernooij <jelmer@samba.org>
parents: 51
diff changeset
31 from bzr-fastimport). python-fastimport lives on launchpad.net at
35
233040cea97a Update README.txt to reflect new dependency on pyfastimport.
Greg Ward <greg-hg@gerg.ca>
parents: 33
diff changeset
32
61
a1558739bd5e Update README to reference lp:python-fastimport rather than Greg's pyfastimport.
Jelmer Vernooij <jelmer@samba.org>
parents: 51
diff changeset
33 https://code.launchpad.net/python-fastimport
35
233040cea97a Update README.txt to reflect new dependency on pyfastimport.
Greg Ward <greg-hg@gerg.ca>
parents: 33
diff changeset
34
61
a1558739bd5e Update README to reference lp:python-fastimport rather than Greg's pyfastimport.
Jelmer Vernooij <jelmer@samba.org>
parents: 51
diff changeset
35 To make the 'fastimport' package provided by python-fastimport available
a1558739bd5e Update README to reference lp:python-fastimport rather than Greg's pyfastimport.
Jelmer Vernooij <jelmer@samba.org>
parents: 51
diff changeset
36 to hg-fastimport, you need to add the python-fastimport directory to
51
d3ae32b7f282 README: misc updates
Greg Ward <greg-hg@gerg.ca>
parents: 35
diff changeset
37 PYTHONPATH, e.g.
35
233040cea97a Update README.txt to reflect new dependency on pyfastimport.
Greg Ward <greg-hg@gerg.ca>
parents: 33
diff changeset
38
51
d3ae32b7f282 README: misc updates
Greg Ward <greg-hg@gerg.ca>
parents: 35
diff changeset
39 PYTHONPATH=$HOME/src/pyfastimport
35
233040cea97a Update README.txt to reflect new dependency on pyfastimport.
Greg Ward <greg-hg@gerg.ca>
parents: 33
diff changeset
40
61
a1558739bd5e Update README to reference lp:python-fastimport rather than Greg's pyfastimport.
Jelmer Vernooij <jelmer@samba.org>
parents: 51
diff changeset
41 It should also be possible to install python-fastimport from cheeshop:
35
233040cea97a Update README.txt to reflect new dependency on pyfastimport.
Greg Ward <greg-hg@gerg.ca>
parents: 33
diff changeset
42
61
a1558739bd5e Update README to reference lp:python-fastimport rather than Greg's pyfastimport.
Jelmer Vernooij <jelmer@samba.org>
parents: 51
diff changeset
43 $ easy_install install python-fastimport
a1558739bd5e Update README to reference lp:python-fastimport rather than Greg's pyfastimport.
Jelmer Vernooij <jelmer@samba.org>
parents: 51
diff changeset
44
a1558739bd5e Update README to reference lp:python-fastimport rather than Greg's pyfastimport.
Jelmer Vernooij <jelmer@samba.org>
parents: 51
diff changeset
45 And most Linux distributions have it packaged.
35
233040cea97a Update README.txt to reflect new dependency on pyfastimport.
Greg Ward <greg-hg@gerg.ca>
parents: 33
diff changeset
46
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
47 USAGE
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
48 -----
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
49
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
50 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
51
33
31b9a5805f02 Rename the extension's package from 'fastimport' to 'hgfastimport'.
Greg Ward <greg-hg@gerg.ca>
parents: 30
diff changeset
52 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
53
51
d3ae32b7f282 README: misc updates
Greg Ward <greg-hg@gerg.ca>
parents: 35
diff changeset
54 to the [extensions] section of your hgrc. Don't forget to set
d3ae32b7f282 README: misc updates
Greg Ward <greg-hg@gerg.ca>
parents: 35
diff changeset
55 PYTHONPATH as explained above.
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
56
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
57 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
58
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
59 hg init new
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
60 hg -R new fastimport FILE...
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 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
63
5
ba7e6a39bf90 Add a README and the GPL
Paul Crowley <paul@lshift.net>
parents:
diff changeset
64
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
65 TESTING
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
66 -------
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
67
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
68 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
69 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
70 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
71
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
72 cd tests
51
d3ae32b7f282 README: misc updates
Greg Ward <greg-hg@gerg.ca>
parents: 35
diff changeset
73 ~/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
74
5
ba7e6a39bf90 Add a README and the GPL
Paul Crowley <paul@lshift.net>
parents:
diff changeset
75
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
76 FURTHER READING
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
77 ---------------
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
78
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
79 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
80
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
81 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
82
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
83 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
84 fast-import format:
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 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
87 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
88 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
89
5
ba7e6a39bf90 Add a README and the GPL
Paul Crowley <paul@lshift.net>
parents:
diff changeset
90
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
91 AVAILABILITY
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
92 ------------
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
93
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
94 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
95 repository:
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 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
98
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 AUTHORS
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 original author:
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
104 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
105 LShift Ltd
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
106
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
107 derived from bzr-fastimport by:
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
108 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
109 Canonical Ltd
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
110
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
111 current maintainer:
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
112 Greg Ward <greg-hg at gerg dot ca>
5
ba7e6a39bf90 Add a README and the GPL
Paul Crowley <paul@lshift.net>
parents:
diff changeset
113
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
114 contributors:
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
115 Paul Aurich <paul at darkrain42 dot org>
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
116
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
117
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
118 COPYRIGHT
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
119 ---------
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 Copyright (C) 2008 Canonical Ltd
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
122 Copyright (C) 2008 LShift Ltd.
5
ba7e6a39bf90 Add a README and the GPL
Paul Crowley <paul@lshift.net>
parents:
diff changeset
123
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
124 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
125 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
126 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
127 (at your option) any later version.
5
ba7e6a39bf90 Add a README and the GPL
Paul Crowley <paul@lshift.net>
parents:
diff changeset
128
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
129 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
130 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
131 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
132 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
133
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
134 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
135 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
136 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.