Mercurial > hg > hg-fastimport
changeset 90:f58882dce2d7
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 | e6602cc471d5 |
| children | c305720d5b7c |
| files | README.rst README.txt setup.py |
| diffstat | 3 files changed, 58 insertions(+), 141 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.rst Tue Jan 19 23:05:11 2021 +0000 @@ -0,0 +1,57 @@ +============= +hg-fastimport +============= + +WARNING: this extension is incomplete and lightly tested. It is +currently intended for Mercurial developers or particularly daring +users. + +hg-fastimport is a Mercurial extension for importing Git's fast-import +dumps into Mercurial. fast-import is a file format for representing the +entire history of a version control repository. + +This file format was designed to make it easier to write tools which +convert from foreign (non-Git) VCS repository formats into Git; such +tools exist for CVS, Mercurial, Darcs, and Perforce. + +============== +How to Install +============== + +Using Pip +--------- + +You can install the latest released version using pip:: + + $ pip install --user hg-fastimport + +Then enable it in yourn hgrc:: + + [extensions] + fastimport = + +From Source +----------- + +To install a local version from source:: + + $ hg clone https://roy.marples.name/hg/hg-fastimport/ + $ cd hg-fastimport + $ pip install --user . + +Then enable it in your hgrc:: + + [extensions] + fastimport = + +========== +How to Use +========== + +To import into a brand-new Mercurial repository:: + + $ hg init new + $ cd new + $ hg fastimport --datesort FILE... + +where FILE... is a list of one or more fast-import dumps.
--- a/README.txt Tue Jan 19 23:00:57 2021 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,140 +0,0 @@ -hg-fastimport -------------- - -WARNING: this extension is incomplete and lightly tested. It is -currently intended for Mercurial developers or particularly daring -users. - -hg-fastimport is a Mercurial extension for importing Git's fast-import -dumps into Mercurial. fast-import is a file format for representing the -entire history of a version control repository. - -This file format was designed to make it easier to write tools which -convert from foreign (non-Git) VCS repository formats into Git; such -tools exist for CVS, Mercurial, Darcs, and Perforce. - -However, there's no reason Git should be the only VCS to read -git-fast-import files; for example, Bazaar has a fastimport extension -similar in scope and aim to hg-fastimport. (In fact, hg-fastimport -draws heavily on the work done for bzr-fastimport.) - -The goal of hg-fastimport is to make it just as easy to populate a -Mercurial repository from a fastimport dump as it is for Bazaar or Git. - - -DEPENDENCIES ------------- - -hg-fastimport depends on: - - * Mercurial 1.9 .. 2.3 - * python-fastimport - -The easiest way to get python-fastimport to use OS packages. E.g. for -Debian and Ubuntu: - - sudo aptitude install python-fastimport - -Likewise for Fedora: - - sudo yum install python-fastimport - -On other operating systems, you can install from PyPI: - - pip install fastimport - -If all else fails, you can find the source for python-fastimport here: - - https://github.com/jelmer/python-fastimport - -USAGE ------ - -To use hg-fastimport, add a line like - - fastimport = /path/to/hg-fastimport/hgfastimport - -to the [extensions] section of your hgrc. Don't forget to install -python-fastimport as explained above. - -To import into a brand-new Mercurial repository: - - hg init new - hg -R new fastimport FILE... - -where FILE... is a list of one or more fast-import dumps. - - -TESTING -------- - -hg-fastimport uses Mercurial's own testing infrastructure, so you will -need a copy of the Mercurial source handy. For example, I keep a clone -of Mercurial "crew" in ~/src/hg-crew. To test hg-fastimport: - - cd tests - ~/src/hg-crew/tests/run-tests.py --local - - -FURTHER READING ---------------- - -The fast-import format is documented in the git-fast-import(1) man page: - - http://www.kernel.org/pub/software/scm/git-core/docs/git-fast-import.html - -Tools to convert various version control repositories to -fast-import format: - - http://cvs2svn.tigris.org/cvs2git.html (CVS) - http://repo.or.cz/w/fast-export.git (Mercurial, Subversion) - http://repo.or.cz/w/darcs2git.git (Darcs) - - -AVAILABILITY ------------- - -You can get the latest copy of hg-fastimport from its public Mercurial -repository: - - hg clone http://vc.gerg.ca/hg/hg-fastimport - - -AUTHORS -------- - -original author: - Paul Crowley <paul at lshift dot net> - LShift Ltd - -derived from bzr-fastimport by: - Ian Clatworthy <ian.clatworthy at internode dot on dot net> - Canonical Ltd - -current maintainer: - Greg Ward <greg-hg at gerg dot ca> - -contributors: - Paul Aurich <paul at darkrain42 dot org> - Jelmer Vernooij <jelmer at samba dot org> - - -COPYRIGHT ---------- - -Copyright (C) 2008 Canonical Ltd -Copyright (C) 2008 LShift Ltd. - -This program is free software; you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 2 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License along -with this program; if not, write to the Free Software Foundation, Inc., -51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
--- a/setup.py Tue Jan 19 23:00:57 2021 +0000 +++ b/setup.py Tue Jan 19 23:05:11 2021 +0000 @@ -31,7 +31,7 @@ maintainer_email='roy@marples.name', url='https://roy.marples.name/hg/hg-fastimport/', description='Mercurial extension for importing from a git fast-import stream.', - long_description=open(join(dirname(__file__), 'README.txt')).read(), + long_description=open(join(dirname(__file__), 'README.rst')).read(), keywords='hg git mercurial', license='GPLv2', packages=py_packages,
