cvs2svn_lib/bzr_run_options.py

   1 # (Be in -*- python -*- mode.)
   2 #
   3 # ====================================================================
   4 # Copyright (c) 2000-2009 CollabNet.  All rights reserved.
   5 #
   6 # This software is licensed as described in the file COPYING, which
   7 # you should have received as part of this distribution.  The terms
   8 # are also available at http://subversion.tigris.org/license-1.html.
   9 # If newer versions of this license are posted there, you may use a
  10 # newer version instead, at your option.
  11 #
  12 # This software consists of voluntary contributions made by many
  13 # individuals.  For exact contribution history, see the revision
  14 # history and logs, available at http://cvs2svn.tigris.org/.
  15 # ====================================================================
  16
  17 """This module manages cvs2bzr run options."""
  18
  19
  20 from cvs2svn_lib.common import FatalError
  21 from cvs2svn_lib.context import Ctx
  22 from cvs2svn_lib.dvcs_common import DVCSRunOptions
  23 from cvs2svn_lib.run_options import ContextOption
  24 from cvs2svn_lib.run_options import IncompatibleOption
  25 from cvs2svn_lib.run_options import not_both
  26 from cvs2svn_lib.revision_manager import NullRevisionCollector
  27 from cvs2svn_lib.rcs_revision_manager import RCSRevisionReader
  28 from cvs2svn_lib.cvs_revision_manager import CVSRevisionReader
  29 from cvs2svn_lib.output_option import NullOutputOption
  30 from cvs2svn_lib.git_output_option import GitRevisionInlineWriter
  31 from cvs2svn_lib.bzr_output_option import BzrOutputOption
  32
  33
  34 class BzrRunOptions(DVCSRunOptions):
  35
  36   short_desc = 'convert a cvs repository into a Bazaar repository'
  37
  38   synopsis = """\
  39 .B cvs2bzr
  40 [\\fIOPTION\\fR]... \\fIOUTPUT-OPTIONS CVS-REPOS-PATH\\fR
  41 .br
  42 .B cvs2bzr
  43 [\\fIOPTION\\fR]... \\fI--options=PATH\\fR
  44 """
  45
  46   long_desc = """\
  47 Create a new Bazaar repository based on the version history stored in a
  48 CVS repository. Each CVS commit will be mirrored in the Bazaar
  49 repository, including such information as date of commit and id of the
  50 committer.
  51 .P
  52 The output of this program is a "fast-import dumpfile", which
  53 can be loaded into a Bazaar repository using the Bazaar FastImport
  54 Plugin, available from https://launchpad.net/bzr-fastimport.
  55
  56 .P
  57 \\fICVS-REPOS-PATH\\fR is the filesystem path of the part of the CVS
  58 repository that you want to convert.  This path doesn't have to be the
  59 top level directory of a CVS repository; it can point at a project
  60 within a repository, in which case only that project will be
  61 converted.  This path or one of its parent directories has to contain
  62 a subdirectory called CVSROOT (though the CVSROOT directory can be
  63 empty).
  64 .P
  65 It is not possible directly to convert a CVS repository to which you
  66 only have remote access, but the FAQ describes tools that may be used
  67 to create a local copy of a remote CVS repository.
  68 """
  69
  70   files = """\
  71 A directory called \\fIcvs2svn-tmp\\fR (or the directory specified by
  72 \\fB--tmpdir\\fR) is used as scratch space for temporary data files.
  73 """
  74
  75   see_also = [
  76     ('cvs', '1'),
  77     ('bzr', '1'),
  78     ]
  79
  80
  81   def _get_output_options_group(self):
  82     group = super(BzrRunOptions, self)._get_output_options_group()
  83
  84     group.add_option(IncompatibleOption(
  85         '--dumpfile', type='string',
  86         action='store',
  87         help='path to which the data should be written',
  88         man_help=(
  89             'Write the blobs and revision data to \\fIpath\\fR.'
  90             ),
  91         metavar='PATH',
  92         ))
  93     group.add_option(ContextOption(
  94         '--dry-run',
  95         action='store_true',
  96         help=(
  97             'do not create any output; just print what would happen.'
  98             ),
  99         man_help=(
 100             'Do not create any output; just print what would happen.'
 101             ),
 102         ))
 103
 104     return group
 105
 106   def _get_extraction_options_group(self):
 107     group = super(BzrRunOptions, self)._get_extraction_options_group()
 108     self._add_use_cvs_option(group)
 109     self._add_use_rcs_option(group)
 110     return group
 111
 112   def process_extraction_options(self):
 113     """Process options related to extracting data from the CVS repository."""
 114
 115     options = self.options
 116
 117     not_both(options.use_rcs, '--use-rcs',
 118              options.use_cvs, '--use-cvs')
 119
 120     # cvs2bzr defers acting on extraction options to process_output_options
 121
 122   def process_output_options(self):
 123     """Process options related to fastimport output."""
 124     ctx = Ctx()
 125     options = self.options
 126
 127     if options.use_rcs:
 128       revision_reader = RCSRevisionReader(
 129           co_executable=options.co_executable
 130           )
 131     else:
 132       # --use-cvs is the default:
 133       revision_reader = CVSRevisionReader(
 134           cvs_executable=options.cvs_executable
 135           )
 136
 137     if not ctx.dry_run and not options.dumpfile:
 138       raise FatalError("must pass '--dry-run' or '--dumpfile' option.")
 139
 140     # See cvs2bzr-example.options for explanations of these
 141     ctx.revision_collector = NullRevisionCollector()
 142     ctx.revision_reader = None
 143
 144     if ctx.dry_run:
 145       ctx.output_option = NullOutputOption()
 146     else:
 147       ctx.output_option = BzrOutputOption(
 148           options.dumpfile,
 149           GitRevisionInlineWriter(revision_reader),
 150           # Optional map from CVS author names to bzr author names:
 151           author_transforms={}, # FIXME
 152           )