cvs2svn_lib/git_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 cvs2git run options."""
  18
  19 import tempfile
  20
  21 from cvs2svn_lib.common import FatalError
  22 from cvs2svn_lib.context import Ctx
  23 from cvs2svn_lib.dvcs_common import DVCSRunOptions
  24 from cvs2svn_lib.run_options import ContextOption
  25 from cvs2svn_lib.run_options import IncompatibleOption
  26 from cvs2svn_lib.run_options import not_both
  27 from cvs2svn_lib.revision_manager import NullRevisionCollector
  28 from cvs2svn_lib.rcs_revision_manager import RCSRevisionReader
  29 from cvs2svn_lib.cvs_revision_manager import CVSRevisionReader
  30 from cvs2svn_lib.git_revision_collector import GitRevisionCollector
  31 from cvs2svn_lib.external_blob_generator import ExternalBlobGenerator
  32 from cvs2svn_lib.output_option import NullOutputOption
  33 from cvs2svn_lib.git_output_option import GitRevisionMarkWriter
  34 from cvs2svn_lib.git_output_option import GitOutputOption
  35
  36
  37 class GitRunOptions(DVCSRunOptions):
  38
  39   short_desc = 'convert a cvs repository into a git repository'
  40
  41   synopsis = """\
  42 .B cvs2git
  43 [\\fIOPTION\\fR]... \\fIOUTPUT-OPTIONS CVS-REPOS-PATH\\fR
  44 .br
  45 .B cvs2git
  46 [\\fIOPTION\\fR]... \\fI--options=PATH\\fR
  47 """
  48
  49   long_desc = """\
  50 Create a new git repository based on the version history stored in a
  51 CVS repository. Each CVS commit will be mirrored in the git
  52 repository, including such information as date of commit and id of the
  53 committer.
  54 .P
  55 The output of this program are a "blobfile" and a "dumpfile", which
  56 together can be loaded into a git repository using "git fast-import".
  57 .P
  58 \\fICVS-REPOS-PATH\\fR is the filesystem path of the part of the CVS
  59 repository that you want to convert.  This path doesn't have to be the
  60 top level directory of a CVS repository; it can point at a project
  61 within a repository, in which case only that project will be
  62 converted.  This path or one of its parent directories has to contain
  63 a subdirectory called CVSROOT (though the CVSROOT directory can be
  64 empty).
  65 .P
  66 It is not possible directly to convert a CVS repository to which you
  67 only have remote access, but the FAQ describes tools that may be used
  68 to create a local copy of a remote CVS repository.
  69 """
  70
  71   files = """\
  72 A directory under \\fI%s\\fR (or the directory specified by
  73 \\fB--tmpdir\\fR) is used as scratch space for temporary data files.
  74 """ % (tempfile.gettempdir(),)
  75
  76   see_also = [
  77     ('cvs', '1'),
  78     ('git', '1'),
  79     ('git-fast-import', '1'),
  80     ]
  81
  82   DEFAULT_USERNAME = 'cvs2git'
  83
  84   def _get_output_options_group(self):
  85     group = super(GitRunOptions, self)._get_output_options_group()
  86
  87     group.add_option(IncompatibleOption(
  88         '--blobfile', type='string',
  89         action='store',
  90         help='path to which the "blob" data should be written',
  91         man_help=(
  92             'Write the "blob" data (containing revision contents) to '
  93             '\\fIpath\\fR.'
  94             ),
  95         metavar='PATH',
  96         ))
  97     group.add_option(IncompatibleOption(
  98         '--dumpfile', type='string',
  99         action='store',
 100         help='path to which the revision data should be written',
 101         man_help=(
 102             'Write the revision data (branches and commits) to \\fIpath\\fR.'
 103             ),
 104         metavar='PATH',
 105         ))
 106     group.add_option(ContextOption(
 107         '--dry-run',
 108         action='store_true',
 109         help=(
 110             'do not create any output; just print what would happen.'
 111             ),
 112         man_help=(
 113             'Do not create any output; just print what would happen.'
 114             ),
 115         ))
 116
 117     return group
 118
 119   def _get_extraction_options_group(self):
 120     group = super(GitRunOptions, self)._get_extraction_options_group()
 121     self._add_use_cvs_option(group)
 122     self._add_use_rcs_option(group)
 123     self.parser.set_default('use_external_blob_generator', False)
 124     group.add_option(IncompatibleOption(
 125         '--use-external-blob-generator',
 126         action='store_true',
 127         help=(
 128             'Use an external Python program to extract file revision '
 129             'contents (much faster than --use-rcs or --use-cvs but '
 130             'leaves keywords unexpanded and requires a separate, '
 131             'seekable blob file to write to in parallel to the main '
 132             'cvs2git script.'
 133             ),
 134         man_help=(
 135             'Use an external Python program to extract the file revision '
 136             'contents from the RCS files and output them to the blobfile.  '
 137             'This option is much faster than \\fB--use-rcs\\fR or '
 138             '\\fB--use-cvs\\fR but leaves keywords unexpanded and requires '
 139             'a separate, seekable blob file to write to in parallel to the '
 140             'main cvs2git script.'
 141             ),
 142         ))
 143
 144     return group
 145
 146   def process_extraction_options(self):
 147     """Process options related to extracting data from the CVS repository."""
 148
 149     ctx = Ctx()
 150     options = self.options
 151
 152     not_both(options.use_rcs, '--use-rcs',
 153              options.use_cvs, '--use-cvs')
 154     not_both(options.use_external_blob_generator,
 155                  '--use-external-blob-generator',
 156              options.use_cvs, '--use-cvs')
 157     not_both(options.use_external_blob_generator,
 158                  '--use-external-blob-generator',
 159              options.use_rcs, '--use-rcs')
 160
 161     # cvs2git never needs a revision reader:
 162     ctx.revision_reader = None
 163
 164     if ctx.dry_run:
 165       ctx.revision_collector = NullRevisionCollector()
 166       return
 167
 168     if not (options.blobfile and options.dumpfile):
 169       raise FatalError("must pass '--blobfile' and '--dumpfile' options.")
 170
 171     if options.use_external_blob_generator:
 172       ctx.revision_collector = ExternalBlobGenerator(options.blobfile)
 173     else:
 174       if options.use_rcs:
 175         revision_reader = RCSRevisionReader(
 176             co_executable=options.co_executable
 177             )
 178       else:
 179         # --use-cvs is the default:
 180         revision_reader = CVSRevisionReader(
 181             cvs_executable=options.cvs_executable
 182             )
 183       ctx.revision_collector = GitRevisionCollector(
 184           options.blobfile, revision_reader,
 185           )
 186
 187   def process_output_options(self):
 188     """Process options related to fastimport output."""
 189     ctx = Ctx()
 190     if ctx.dry_run:
 191       ctx.output_option = NullOutputOption()
 192     else:
 193       ctx.output_option = GitOutputOption(
 194           self.options.dumpfile,
 195           GitRevisionMarkWriter(),
 196           # Optional map from CVS author names to git author names:
 197           author_transforms={}, # FIXME
 198           )