Mercurial > hg > hg-fastimport

annotate README.rst @ 90:f58882dce2d7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Move README.txt to README.rst and tidy up Now reflects no dependencies, how to install using pip and how to use it. All other information has been discarded and can be found by looking in other files.
author Roy Marples <roy@marples.name>
date Tue, 19 Jan 2021 23:05:11 +0000
parents README.txt@a739b8dc8e6f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
90
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
1 =============
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
2 hg-fastimport
90
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
3 =============
5
ba7e6a39bf90 Add a README and the GPL
Paul Crowley <paul@lshift.net>
parents:
diff changeset
4
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
5 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
6 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
7 users.
5
ba7e6a39bf90 Add a README and the GPL
Paul Crowley <paul@lshift.net>
parents:
diff changeset
8
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
9 hg-fastimport is a Mercurial extension for importing Git's fast-import
90
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
10 dumps into Mercurial. fast-import is a file format for representing the
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
11 entire history of a version control repository.
5
ba7e6a39bf90 Add a README and the GPL
Paul Crowley <paul@lshift.net>
parents:
diff changeset
12
6
0185a9b236eb Line wrap README
Paul Crowley <paul@lshift.net>
parents: 5
diff changeset
13 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
14 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
15 tools exist for CVS, Mercurial, Darcs, and Perforce.
5
ba7e6a39bf90 Add a README and the GPL
Paul Crowley <paul@lshift.net>
parents:
diff changeset
16
90
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
17 ==============
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
18 How to Install
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
19 ==============
5
ba7e6a39bf90 Add a README and the GPL
Paul Crowley <paul@lshift.net>
parents:
diff changeset
20
90
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
21 Using Pip
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
22 ---------
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
23
90
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
24 You can install the latest released version using pip::
35
233040cea97a Update README.txt to reflect new dependency on pyfastimport.
Greg Ward <greg-hg@gerg.ca>
parents: 33
diff changeset
25
90
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
26 $ pip install --user hg-fastimport
67
d88ce26e0946 README: improve dependency instructions.
Greg Ward <greg@gerg.ca>
parents: 63
diff changeset
27
90
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
28 Then enable it in yourn hgrc::
51
d3ae32b7f282 README: misc updates
Greg Ward <greg-hg@gerg.ca>
parents: 35
diff changeset
29
90
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
30 [extensions]
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
31 fastimport =
35
233040cea97a Update README.txt to reflect new dependency on pyfastimport.
Greg Ward <greg-hg@gerg.ca>
parents: 33
diff changeset
32
90
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
33 From Source
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
34 -----------
35
233040cea97a Update README.txt to reflect new dependency on pyfastimport.
Greg Ward <greg-hg@gerg.ca>
parents: 33
diff changeset
35
90
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
36 To install a local version from source::
35
233040cea97a Update README.txt to reflect new dependency on pyfastimport.
Greg Ward <greg-hg@gerg.ca>
parents: 33
diff changeset
37
90
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
38 $ hg clone https://roy.marples.name/hg/hg-fastimport/
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
39 $ cd hg-fastimport
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
40 $ pip install --user .
35
233040cea97a Update README.txt to reflect new dependency on pyfastimport.
Greg Ward <greg-hg@gerg.ca>
parents: 33
diff changeset
41
90
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
42 Then enable it in your hgrc::
35
233040cea97a Update README.txt to reflect new dependency on pyfastimport.
Greg Ward <greg-hg@gerg.ca>
parents: 33
diff changeset
43
90
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
44 [extensions]
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
45 fastimport =
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
46
90
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
47 ==========
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
48 How to Use
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
49 ==========
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
50
90
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
51 To import into a brand-new Mercurial repository::
30
87873075e128 Rename README to README.txt and rewrite it.
Greg Ward <greg-hg@gerg.ca>
parents: 8
diff changeset
52
90
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
53 $ hg init new
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
54 $ cd new
f58882dce2d7 Move README.txt to README.rst and tidy up
Roy Marples <roy@marples.name>
parents: 70
diff changeset
55 $ hg fastimport --datesort FILE...
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 where FILE... is a list of one or more fast-import dumps.