__init__.py
382 lines
| 15.2 KiB
| text/x-python
|
PythonLexer
|
r4513 | # convert.py Foreign SCM converter | ||
|
r4512 | # | ||
|
r4635 | # Copyright 2005-2007 Matt Mackall <mpm@selenic.com> | ||
|
r4512 | # | ||
|
r8225 | # This software may be used and distributed according to the terms of the | ||
|
r10263 | # GNU General Public License version 2 or any later version. | ||
|
r8228 | |||
|
r8932 | '''import revisions from foreign VCS repositories into Mercurial''' | ||
|
r4512 | |||
|
r5621 | import convcmd | ||
|
r7502 | import cvsps | ||
|
r7873 | import subversion | ||
|
r13691 | from mercurial import commands, templatekw | ||
|
r6999 | from mercurial.i18n import _ | ||
|
r4512 | |||
|
r16743 | testedwith = 'internal' | ||
|
r5621 | # Commands definition was moved elsewhere to ease demandload job. | ||
|
r4512 | |||
|
r5281 | def convert(ui, src, dest=None, revmapfile=None, **opts): | ||
|
r7598 | """convert a foreign SCM repository to a Mercurial one. | ||
|
r4513 | |||
|
r6976 | Accepted source formats [identifiers]: | ||
|
r9157 | |||
|
r6976 | - Mercurial [hg] | ||
- CVS [cvs] | ||||
- Darcs [darcs] | ||||
- git [git] | ||||
- Subversion [svn] | ||||
- Monotone [mtn] | ||||
- GNU Arch [gnuarch] | ||||
|
r7053 | - Bazaar [bzr] | ||
|
r7823 | - Perforce [p4] | ||
|
r4513 | |||
|
r6976 | Accepted destination formats [identifiers]: | ||
|
r9157 | |||
|
r6976 | - Mercurial [hg] | ||
- Subversion [svn] (history on branches is not preserved) | ||||
|
r4513 | |||
|
r9256 | If no revision is given, all revisions will be converted. | ||
Otherwise, convert will only import up to the named revision | ||||
(given in a format understood by the source). | ||||
|
r4760 | |||
|
r9256 | If no destination directory name is specified, it defaults to the | ||
|
r12185 | basename of the source with ``-hg`` appended. If the destination | ||
|
r9256 | repository doesn't exist, it will be created. | ||
|
r4513 | |||
|
r9256 | By default, all sources except Mercurial will use --branchsort. | ||
Mercurial uses --sourcesort to preserve original revision numbers | ||||
order. Sort modes have the following effects: | ||||
|
r9103 | |||
|
r9256 | --branchsort convert from parent to child revision when possible, | ||
which means branches are usually converted one after | ||||
the other. It generates more compact repositories. | ||||
|
r9157 | |||
--datesort sort revisions by date. Converted repositories have | ||||
|
r9256 | good-looking changelogs but are often an order of | ||
magnitude larger than the same ones generated by | ||||
--branchsort. | ||||
|
r9157 | |||
|
r9256 | --sourcesort try to preserve source revisions order, only | ||
supported by Mercurial sources. | ||||
|
r8692 | |||
|
r18819 | --closesort try to move closed revisions as close as possible | ||
to parent branches, only supported by Mercurial | ||||
sources. | ||||
|
r12924 | If ``REVMAP`` isn't given, it will be put in a default location | ||
(``<dest>/.hg/shamap`` by default). The ``REVMAP`` is a simple | ||||
text file that maps each source commit ID to the destination ID | ||||
for that revision, like so:: | ||||
|
r9058 | |||
|
r9157 | <source ID> <destination ID> | ||
|
r4513 | |||
|
r9256 | If the file doesn't exist, it's automatically created. It's | ||
|
r12186 | updated on each commit copied, so :hg:`convert` can be interrupted | ||
|
r9256 | and can be run repeatedly to copy new commits. | ||
|
r4589 | |||
|
r12198 | The authormap is a simple text file that maps each source commit | ||
author to a destination commit author. It is handy for source SCMs | ||||
|
r17424 | that use unix logins to identify authors (e.g.: CVS). One line per | ||
|
r12198 | author mapping and the line format is:: | ||
|
r12184 | |||
source author = destination author | ||||
Empty lines and lines starting with a ``#`` are ignored. | ||||
|
r5256 | |||
|
r9256 | The filemap is a file that allows filtering and remapping of files | ||
|
r11523 | and directories. Each line can contain one of the following | ||
directives:: | ||||
include path/to/file-or-dir | ||||
exclude path/to/file-or-dir | ||||
|
r5256 | |||
|
r11523 | rename path/to/source path/to/destination | ||
|
r5256 | |||
|
r12188 | Comment lines start with ``#``. A specified path matches if it | ||
|
r11523 | equals the full relative name of a file or one of its parent | ||
|
r12185 | directories. The ``include`` or ``exclude`` directive with the | ||
longest matching path applies, so line order does not matter. | ||||
|
r5760 | |||
|
r12185 | The ``include`` directive causes a file, or all files under a | ||
|
r9256 | directory, to be included in the destination repository, and the | ||
exclusion of all other files and directories not explicitly | ||||
|
r12185 | included. The ``exclude`` directive causes files or directories to | ||
be omitted. The ``rename`` directive renames a file or directory if | ||||
|
r11685 | it is converted. To rename from a subdirectory into the root of | ||
|
r12188 | the repository, use ``.`` as the path to rename to. | ||
|
r5556 | |||
|
r9256 | The splicemap is a file that allows insertion of synthetic | ||
history, letting you specify the parents of a revision. This is | ||||
useful if you want to e.g. give a Subversion merge two parents, or | ||||
graft two disconnected series of history together. Each entry | ||||
contains a key, followed by a space, followed by one or two | ||||
|
r12184 | comma-separated values:: | ||
key parent1, parent2 | ||||
The key is the revision ID in the source | ||||
|
r9256 | revision control system whose parents should be modified (same | ||
format as a key in .hg/shamap). The values are the revision IDs | ||||
(in either the source or destination revision control system) that | ||||
|
r9634 | should be used as the new parents for that node. For example, if | ||
you have merged "release-1.0" into "trunk", then you should | ||||
specify the revision on "trunk" as the first parent and the one on | ||||
the "release-1.0" branch as the second. | ||||
|
r6143 | |||
|
r8377 | The branchmap is a file that allows you to rename a branch when it is | ||
being brought in from whatever external repository. When used in | ||||
|
r9256 | conjunction with a splicemap, it allows for a powerful combination | ||
to help fix even the most badly mismanaged repositories and turn them | ||||
into nicely structured Mercurial repositories. The branchmap contains | ||||
|
r12184 | lines of the form:: | ||
original_branch_name new_branch_name | ||||
where "original_branch_name" is the name of the branch in the | ||||
source repository, and "new_branch_name" is the name of the branch | ||||
is the destination repository. No whitespace is allowed in the | ||||
branch names. This can be used to (for instance) move code in one | ||||
repository from "default" to a named branch. | ||||
|
r8377 | |||
|
r6169 | Mercurial Source | ||
|
r17267 | ################ | ||
|
r6169 | |||
|
r12922 | The Mercurial source recognizes the following configuration | ||
options, which you can set on the command line with ``--config``: | ||||
|
r12923 | :convert.hg.ignoreerrors: ignore integrity errors when reading. | ||
Use it to fix Mercurial repositories with missing revlogs, by | ||||
converting from and to Mercurial. Default is False. | ||||
|
r13429 | :convert.hg.saverev: store original revision ID in changeset | ||
|
r15300 | (forces target IDs to change). It takes a boolean argument and | ||
defaults to False. | ||||
|
r12923 | |||
|
r19891 | :convert.hg.revs: revset specifying the source revisions to convert. | ||
|
r6169 | |||
|
r6798 | CVS Source | ||
|
r17267 | ########## | ||
|
r6798 | |||
|
r9256 | CVS source will use a sandbox (i.e. a checked-out copy) from CVS | ||
to indicate the starting point of what will be converted. Direct | ||||
access to the repository files is not needed, unless of course the | ||||
|
r12924 | repository is ``:local:``. The conversion uses the top level | ||
directory in the sandbox to find the CVS repository, and then uses | ||||
CVS rlog commands to find files to convert. This means that unless | ||||
a filemap is given, all files under the starting directory will be | ||||
|
r9256 | converted, and that any directory reorganization in the CVS | ||
sandbox is ignored. | ||||
|
r6798 | |||
|
r12922 | The following options can be used with ``--config``: | ||
|
r6798 | |||
|
r12923 | :convert.cvsps.cache: Set to False to disable remote log caching, | ||
for testing and debugging purposes. Default is True. | ||||
:convert.cvsps.fuzz: Specify the maximum time (in seconds) that is | ||||
allowed between commits with identical user and log message in | ||||
a single changeset. When very large files were checked in as | ||||
part of a changeset then the default may not be long enough. | ||||
The default is 60. | ||||
:convert.cvsps.mergeto: Specify a regular expression to which | ||||
commit log messages are matched. If a match occurs, then the | ||||
conversion process will insert a dummy revision merging the | ||||
branch on which this log message occurs to the branch | ||||
indicated in the regex. Default is ``{{mergetobranch | ||||
([-\\w]+)}}`` | ||||
:convert.cvsps.mergefrom: Specify a regular expression to which | ||||
commit log messages are matched. If a match occurs, then the | ||||
conversion process will add the most recent revision on the | ||||
branch indicated in the regex as the second parent of the | ||||
changeset. Default is ``{{mergefrombranch ([-\\w]+)}}`` | ||||
|
r17974 | :convert.localtimezone: use local time (as determined by the TZ | ||
environment variable) for changeset date/times. The default | ||||
is False (use UTC). | ||||
|
r18321 | :hooks.cvslog: Specify a Python function to be called at the end of | ||
|
r12923 | gathering the CVS log. The function is passed a list with the | ||
log entries, and can modify the entries in-place, or add or | ||||
delete them. | ||||
|
r18321 | :hooks.cvschangesets: Specify a Python function to be called after | ||
|
r17251 | the changesets are calculated from the CVS log. The | ||
|
r12923 | function is passed a list with the changeset entries, and can | ||
modify the changesets in-place, or add or delete them. | ||||
|
r6923 | |||
|
r9472 | An additional "debugcvsps" Mercurial command allows the builtin | ||
|
r9256 | changeset merging code to be run without doing a conversion. Its | ||
|
r9472 | parameters and output are similar to that of cvsps 2.1. Please see | ||
the command help for more details. | ||||
|
r6798 | |||
|
r6169 | Subversion Source | ||
|
r17267 | ################# | ||
|
r6169 | |||
|
r9256 | Subversion source detects classical trunk/branches/tags layouts. | ||
|
r12924 | By default, the supplied ``svn://repo/path/`` source URL is | ||
converted as a single branch. If ``svn://repo/path/trunk`` exists | ||||
it replaces the default branch. If ``svn://repo/path/branches`` | ||||
exists, its subdirectories are listed as possible branches. If | ||||
``svn://repo/path/tags`` exists, it is looked for tags referencing | ||||
converted branches. Default ``trunk``, ``branches`` and ``tags`` | ||||
values can be overridden with following options. Set them to paths | ||||
|
r9256 | relative to the source URL, or leave them blank to disable auto | ||
detection. | ||||
|
r6169 | |||
|
r12922 | The following options can be set with ``--config``: | ||
|
r12923 | :convert.svn.branches: specify the directory containing branches. | ||
|
r13494 | The default is ``branches``. | ||
|
r12923 | |||
:convert.svn.tags: specify the directory containing tags. The | ||||
|
r12924 | default is ``tags``. | ||
|
r12923 | |||
|
r13494 | :convert.svn.trunk: specify the name of the trunk branch. The | ||
default is ``trunk``. | ||||
|
r6169 | |||
|
r17974 | :convert.localtimezone: use local time (as determined by the TZ | ||
environment variable) for changeset date/times. The default | ||||
is False (use UTC). | ||||
|
r9256 | Source history can be retrieved starting at a specific revision, | ||
instead of being integrally converted. Only single branch | ||||
conversions are supported. | ||||
|
r6173 | |||
|
r12923 | :convert.svn.startrev: specify start Subversion revision number. | ||
The default is 0. | ||||
|
r6173 | |||
|
r7823 | Perforce Source | ||
|
r17267 | ############### | ||
|
r7823 | |||
|
r9256 | The Perforce (P4) importer can be given a p4 depot path or a | ||
client specification as source. It will convert all files in the | ||||
source to a flat Mercurial repository, ignoring labels, branches | ||||
and integrations. Note that when a depot path is given you then | ||||
usually should specify a target directory, because otherwise the | ||||
|
r12924 | target may be named ``...-hg``. | ||
|
r7823 | |||
|
r9256 | It is possible to limit the amount of source history to be | ||
|
r12922 | converted by specifying an initial Perforce revision: | ||
|
r7823 | |||
|
r13429 | :convert.p4.startrev: specify initial Perforce revision (a | ||
|
r12923 | Perforce changelist number). | ||
|
r7823 | |||
|
r6169 | Mercurial Destination | ||
|
r17267 | ##################### | ||
|
r5556 | |||
|
r12922 | The following options are supported: | ||
|
r12923 | :convert.hg.clonebranches: dispatch source branches in separate | ||
clones. The default is False. | ||||
|
r12922 | :convert.hg.tagsbranch: branch name for tag revisions, defaults to | ||
``default``. | ||||
|
r5556 | |||
|
r12923 | :convert.hg.usebranchnames: preserve branch names. The default is | ||
|
r13429 | True. | ||
|
r4958 | """ | ||
|
r5621 | return convcmd.convert(ui, src, dest, revmapfile, **opts) | ||
|
r4512 | |||
|
r5621 | def debugsvnlog(ui, **opts): | ||
|
r7873 | return subversion.debugsvnlog(ui, **opts) | ||
|
r4512 | |||
|
r7502 | def debugcvsps(ui, *args, **opts): | ||
|
r7598 | '''create changeset information from CVS | ||
|
r7502 | |||
|
r9256 | This command is intended as a debugging tool for the CVS to | ||
Mercurial converter, and can be used as a direct replacement for | ||||
cvsps. | ||||
|
r7502 | |||
|
r9256 | Hg debugcvsps reads the CVS rlog for current directory (or any | ||
named directory) in the CVS repository, and converts the log to a | ||||
series of changesets based on matching commit log entries and | ||||
dates.''' | ||||
|
r7502 | return cvsps.debugcvsps(ui, *args, **opts) | ||
commands.norepo += " convert debugsvnlog debugcvsps" | ||||
|
r5127 | |||
|
r4513 | cmdtable = { | ||
|
r4532 | "convert": | ||
|
r5281 | (convert, | ||
|
r12202 | [('', 'authors', '', | ||
|
r12198 | _('username mapping filename (DEPRECATED, use --authormap instead)'), | ||
_('FILE')), | ||||
|
r12187 | ('s', 'source-type', '', | ||
_('source repository type'), _('TYPE')), | ||||
|
r11321 | ('d', 'dest-type', '', | ||
_('destination repository type'), _('TYPE')), | ||||
|
r12187 | ('r', 'rev', '', | ||
|
r19864 | _('import up to source revision REV'), _('REV')), | ||
|
r12202 | ('A', 'authormap', '', | ||
|
r12198 | _('remap usernames using this file'), _('FILE')), | ||
|
r11321 | ('', 'filemap', '', | ||
_('remap file names using contents of file'), _('FILE')), | ||||
('', 'splicemap', '', | ||||
_('splice synthesized history into place'), _('FILE')), | ||||
('', 'branchmap', '', | ||||
_('change branch names while converting'), _('FILE')), | ||||
|
r8692 | ('', 'branchsort', None, _('try to sort changesets by branches')), | ||
|
r8690 | ('', 'datesort', None, _('try to sort changesets by date')), | ||
|
r18819 | ('', 'sourcesort', None, _('preserve source changesets order')), | ||
('', 'closesort', None, _('try to reorder closed revisions'))], | ||||
|
r6999 | _('hg convert [OPTION]... SOURCE [DEST [REVMAP]]')), | ||
|
r5138 | "debugsvnlog": | ||
|
r5127 | (debugsvnlog, | ||
[], | ||||
|
r5138 | 'hg debugsvnlog'), | ||
|
r7502 | "debugcvsps": | ||
(debugcvsps, | ||||
[ | ||||
# Main options shared with cvsps-2.1 | ||||
|
r7598 | ('b', 'branches', [], _('only return changes on specified branches')), | ||
('p', 'prefix', '', _('prefix to remove from file names')), | ||||
|
r10282 | ('r', 'revisions', [], | ||
_('only return changes after or between specified tags')), | ||||
|
r7598 | ('u', 'update-cache', None, _("update cvs log cache")), | ||
('x', 'new-cache', None, _("create new cvs log cache")), | ||||
('z', 'fuzz', 60, _('set commit time fuzz in seconds')), | ||||
('', 'root', '', _('specify cvsroot')), | ||||
|
r7502 | # Options specific to builtin cvsps | ||
|
r7598 | ('', 'parents', '', _('show parent changesets')), | ||
|
r16683 | ('', 'ancestors', '', | ||
_('show current changeset in ancestor branches')), | ||||
|
r7502 | # Options that are ignored for compatibility with cvsps-2.1 | ||
|
r7735 | ('A', 'cvs-direct', None, _('ignored for compatibility')), | ||
|
r7502 | ], | ||
|
r7735 | _('hg debugcvsps [OPTION]... [PATH]...')), | ||
|
r4513 | } | ||
|
r13691 | |||
def kwconverted(ctx, name): | ||||
rev = ctx.extra().get('convert_revision', '') | ||||
if rev.startswith('svn:'): | ||||
if name == 'svnrev': | ||||
return str(subversion.revsplit(rev)[2]) | ||||
elif name == 'svnpath': | ||||
return subversion.revsplit(rev)[1] | ||||
elif name == 'svnuuid': | ||||
return subversion.revsplit(rev)[0] | ||||
return rev | ||||
def kwsvnrev(repo, ctx, **args): | ||||
""":svnrev: String. Converted subversion revision number.""" | ||||
return kwconverted(ctx, 'svnrev') | ||||
def kwsvnpath(repo, ctx, **args): | ||||
""":svnpath: String. Converted subversion revision project path.""" | ||||
return kwconverted(ctx, 'svnpath') | ||||
def kwsvnuuid(repo, ctx, **args): | ||||
""":svnuuid: String. Converted subversion revision repository identifier.""" | ||||
return kwconverted(ctx, 'svnuuid') | ||||
def extsetup(ui): | ||||
templatekw.keywords['svnrev'] = kwsvnrev | ||||
templatekw.keywords['svnpath'] = kwsvnpath | ||||
templatekw.keywords['svnuuid'] = kwsvnuuid | ||||
|
r13698 | |||
# tell hggettext to extract docstrings from these functions: | ||||
i18nfunctions = [kwsvnrev, kwsvnpath, kwsvnuuid] | ||||