1 # (Be in -*- mode: python; coding: utf-8 -*- mode.)
3 # ====================================================================
4 # Copyright (c) 2006-2008 CollabNet. All rights reserved.
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.
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 # ====================================================================
17 # #####################
18 # ## PLEASE READ ME! ##
19 # #####################
21 # This is a template for an options file that can be used to configure
22 # cvs2svn to convert to git rather than to Subversion. See
23 # www/cvs2git.html and www/cvs2svn.html for general information, and
24 # see the comments in this file for information about what options are
25 # available and how they can be set.
27 # The program that is run to convert from CVS to git is called
28 # cvs2git. Run it with the --options option, passing it this file as
31 # cvs2git --options=cvs2git-example.options
33 # The output of cvs2git is a blob file and a dump file that can be
34 # loaded into git using the "git fast-import" command. Please read
35 # www/cvs2git.html for more information.
37 # Many options do not have defaults, so it is easier to copy this file
38 # and modify what you need rather than creating a new options file
39 # from scratch. This file is in Python syntax, but you don't need to
40 # know Python to modify it. But if you *do* know Python, then you
41 # will be happy to know that you can use arbitary Python constructs to
42 # do fancy configuration tricks.
44 # But please be aware of the following:
46 # * In many places, leading whitespace is significant in Python (it is
47 # used instead of curly braces to group statements together).
48 # Therefore, if you don't know what you are doing, it is best to
49 # leave the whitespace as it is.
51 # * In normal strings, Python treats a backslash ("\") as an escape
52 # character. Therefore, if you want to specify a string that
53 # contains a backslash, you need either to escape the backslash with
54 # another backslash ("\\"), or use a "raw string", as in one if the
55 # following equivalent examples:
57 # ctx.sort_executable = 'c:\\windows\\system32\\sort.exe'
58 # ctx.sort_executable = r'c:\windows\system32\sort.exe'
60 # See http://docs.python.org/tutorial/introduction.html#strings for
63 # Two identifiers will have been defined before this file is executed,
64 # and can be used freely within this file:
66 # ctx -- a Ctx object (see cvs2svn_lib/context.py), which holds
67 # many configuration options
69 # run_options -- an instance of the GitRunOptions class (see
70 # cvs2svn_lib/git_run_options.py), which holds some variables
71 # governing how cvs2git is run
74 # Import some modules that are used in setting the options:
77 from cvs2svn_lib import config
78 from cvs2svn_lib import changeset_database
79 from cvs2svn_lib.common import CVSTextDecoder
80 from cvs2svn_lib.log import Log
81 from cvs2svn_lib.project import Project
82 from cvs2svn_lib.git_revision_recorder import GitRevisionRecorder
83 from cvs2svn_lib.git_output_option import GitRevisionMarkWriter
84 from cvs2svn_lib.git_output_option import GitOutputOption
85 from cvs2svn_lib.revision_manager import NullRevisionRecorder
86 from cvs2svn_lib.revision_manager import NullRevisionExcluder
87 from cvs2svn_lib.fulltext_revision_recorder \
88 import SimpleFulltextRevisionRecorderAdapter
89 from cvs2svn_lib.rcs_revision_manager import RCSRevisionReader
90 from cvs2svn_lib.cvs_revision_manager import CVSRevisionReader
91 from cvs2svn_lib.checkout_internal import InternalRevisionRecorder
92 from cvs2svn_lib.checkout_internal import InternalRevisionExcluder
93 from cvs2svn_lib.checkout_internal import InternalRevisionReader
94 from cvs2svn_lib.symbol_strategy import AllBranchRule
95 from cvs2svn_lib.symbol_strategy import AllTagRule
96 from cvs2svn_lib.symbol_strategy import BranchIfCommitsRule
97 from cvs2svn_lib.symbol_strategy import ExcludeRegexpStrategyRule
98 from cvs2svn_lib.symbol_strategy import ForceBranchRegexpStrategyRule
99 from cvs2svn_lib.symbol_strategy import ForceTagRegexpStrategyRule
100 from cvs2svn_lib.symbol_strategy import ExcludeTrivialImportBranchRule
101 from cvs2svn_lib.symbol_strategy import ExcludeVendorBranchRule
102 from cvs2svn_lib.symbol_strategy import HeuristicStrategyRule
103 from cvs2svn_lib.symbol_strategy import UnambiguousUsageRule
104 from cvs2svn_lib.symbol_strategy import HeuristicPreferredParentRule
105 from cvs2svn_lib.symbol_strategy import SymbolHintsFileRule
106 from cvs2svn_lib.symbol_transform import ReplaceSubstringsSymbolTransform
107 from cvs2svn_lib.symbol_transform import RegexpSymbolTransform
108 from cvs2svn_lib.symbol_transform import NormalizePathsSymbolTransform
109 from cvs2svn_lib.property_setters import AutoPropsPropertySetter
110 from cvs2svn_lib.property_setters import CVSBinaryFileDefaultMimeTypeSetter
111 from cvs2svn_lib.property_setters import CVSBinaryFileEOLStyleSetter
112 from cvs2svn_lib.property_setters import CVSRevisionNumberSetter
113 from cvs2svn_lib.property_setters import DefaultEOLStyleSetter
114 from cvs2svn_lib.property_setters import EOLStyleFromMimeTypeSetter
115 from cvs2svn_lib.property_setters import ExecutablePropertySetter
116 from cvs2svn_lib.property_setters import KeywordsPropertySetter
117 from cvs2svn_lib.property_setters import MimeMapper
118 from cvs2svn_lib.property_setters import SVNBinaryFileKeywordsPropertySetter
120 # To choose the level of logging output, uncomment one of the
122 #Log().log_level = Log.WARN
123 #Log().log_level = Log.QUIET
124 Log().log_level = Log.NORMAL
125 #Log().log_level = Log.VERBOSE
126 #Log().log_level = Log.DEBUG
129 # During CollectRevsPass, cvs2git records the contents of file
130 # revisions into a "blob" file in git-fast-import format. This option
131 # configures that process:
132 ctx.revision_recorder = SimpleFulltextRevisionRecorderAdapter(
133 # The following option specifies how the revision contents of the RCS
134 # files should be read.
136 # RCSRevisionReader uses RCS's "co" program to extract the revision
137 # contents of the RCS files during CollectRevsPass. The constructor
138 # argument specifies how to invoke the "co" executable.
140 # CVSRevisionReader uses the "cvs" program to extract the revision
141 # contents out of the RCS files during OutputPass. This option is
142 # considerably slower than RCSRevisionReader because "cvs" is
143 # considerably slower than "co". However, it works in some situations
144 # where RCSRevisionReader fails; see the HTML documentation of the
145 # "--use-cvs" option for details. The constructor argument specifies
146 # how to invoke the "co" executable.
148 # Uncomment one of the two following lines:
149 #RCSRevisionReader(co_executable=r'co'),
150 CVSRevisionReader(cvs_executable=r'cvs'),
152 # The file in which to write the git-fast-import stream that
153 # contains the file revision contents:
154 GitRevisionRecorder('cvs2svn-tmp/git-blob.dat'),
157 # cvs2git does not need to keep track of what revisions will be
158 # excluded, so leave this option unchanged:
159 ctx.revision_excluder = NullRevisionExcluder()
161 # cvs2git doesn't need a revision reader because OutputPass only
162 # refers to blobs that were output during CollectRevsPass, so leave
163 # this option set to None.
164 ctx.revision_reader = None
166 # Set the name (and optionally the path) of some other executables
167 # required by cvs2svn:
168 ctx.sort_executable = r'sort'
170 # Change the following line to True if the conversion should only
171 # include the trunk of the repository (i.e., all branches and tags
172 # should be omitted from the conversion):
173 ctx.trunk_only = False
175 # How to convert CVS author names, log messages, and filenames to
176 # unicode. The first argument to CVSTextDecoder is a list of encoders
177 # that are tried in order in 'strict' mode until one of them succeeds.
178 # If none of those succeeds, then fallback_encoder (if it is
179 # specified) is used in lossy 'replace' mode. Setting a fallback
180 # encoder ensures that the encoder always succeeds, but it can cause
182 ctx.cvs_author_decoder = CVSTextDecoder(
188 #fallback_encoding='ascii'
190 ctx.cvs_log_decoder = CVSTextDecoder(
196 #fallback_encoding='ascii'
198 # You might want to be especially strict when converting filenames to
199 # unicode (e.g., maybe not specify a fallback_encoding).
200 ctx.cvs_filename_decoder = CVSTextDecoder(
206 #fallback_encoding='ascii'
209 # Template for the commit message to be used for initial project
211 ctx.initial_project_commit_message = (
212 'Standard project directories initialized by cvs2svn.'
215 # Template for the commit message to be used for post commits, in
216 # which modifications to a vendor branch are copied back to trunk.
217 # This message can use '%(revnum)d' to include the SVN revision number
218 # of the revision that included the change to the vendor branch
219 # (admittedly rather pointless in a cvs2git conversion).
220 ctx.post_commit_message = (
221 'This commit was generated by cvs2svn to track changes on a CVS '
225 # Template for the commit message to be used for commits in which
226 # symbols are created. This message can use '%(symbol_type)d' to
227 # include the type of the symbol ('branch' or 'tag') or
228 # '%(symbol_name)' to include the name of the symbol.
229 ctx.symbol_commit_message = (
230 "This commit was manufactured by cvs2svn to create %(symbol_type)s "
234 # Some CVS clients for MacOS store resource fork data into CVS along
235 # with the file contents itself by wrapping it all up in a container
236 # format called "AppleSingle". Subversion currently does not support
237 # MacOS resource forks. Nevertheless, sometimes the resource fork
238 # information is not necessary and can be discarded. Set the
239 # following option to True if you would like cvs2svn to identify files
240 # whose contents are encoded in AppleSingle format, and discard all
241 # but the data fork for such files before committing them to
242 # Subversion. (Please note that AppleSingle contents are identified
243 # by the AppleSingle magic number as the first four bytes of the file.
244 # This check is not failproof, so only set this option if you think
246 ctx.decode_apple_single = False
248 # This option can be set to the name of a filename to which are stored
249 # statistics and conversion decisions about the CVS symbols.
250 ctx.symbol_info_filename = None
251 #ctx.symbol_info_filename = 'symbol-info.txt'
253 # cvs2svn uses "symbol strategy rules" to help decide how to handle
254 # CVS symbols. The rules in a project's symbol_strategy_rules are
255 # applied in order, and each rule is allowed to modify the symbol.
256 # The result (after each of the rules has been applied) is used for
259 # 1. A CVS symbol might be used as a tag in one file and as a branch
260 # in another file. cvs2svn has to decide whether to convert such a
261 # symbol as a tag or as a branch. cvs2svn uses a series of
262 # heuristic rules to decide how to convert a symbol. The user can
263 # override the default rules for specific symbols or symbols
264 # matching regular expressions.
266 # 2. cvs2svn is also capable of excluding symbols from the conversion
267 # (provided no other symbols depend on them.
269 # 3. CVS does not record unambiguously the line of development from
270 # which a symbol sprouted. cvs2svn uses a heuristic to choose a
271 # symbol's "preferred parents".
273 # The standard branch/tag/exclude StrategyRules do not change a symbol
274 # that has already been processed by an earlier rule, so in effect the
275 # first matching rule is the one that is used.
277 global_symbol_strategy_rules = [
278 # It is possible to specify manually exactly how symbols should be
279 # converted and what line of development should be used as the
280 # preferred parent. To do so, create a file containing the symbol
281 # hints and enable the following option.
283 # The format of the hints file is described in the documentation
284 # for the --symbol-hints command-line option. The file output by
285 # the --write-symbol-info (i.e., ctx.symbol_info_filename) option
286 # is in the same format. The simplest way to use this option is
287 # to run the conversion through CollateSymbolsPass with
288 # --write-symbol-info option, copy the symbol info and edit it to
289 # create a hints file, then re-start the conversion at
290 # CollateSymbolsPass with this option enabled.
291 #SymbolHintsFileRule('symbol-hints.txt'),
293 # To force all symbols matching a regular expression to be
294 # converted as branches, add rules like the following:
295 #ForceBranchRegexpStrategyRule(r'branch.*'),
297 # To force all symbols matching a regular expression to be
298 # converted as tags, add rules like the following:
299 #ForceTagRegexpStrategyRule(r'tag.*'),
301 # To force all symbols matching a regular expression to be
302 # excluded from the conversion, add rules like the following:
303 #ExcludeRegexpStrategyRule(r'unknown-.*'),
305 # Sometimes people use "cvs import" to get their own source code
306 # into CVS. This practice creates a vendor branch 1.1.1 and
307 # imports the code onto the vendor branch as 1.1.1.1, then copies
308 # the same content to the trunk as version 1.1. Normally, such
309 # vendor branches are useless and they complicate the SVN history
310 # unnecessarily. The following rule excludes any branches that
311 # only existed as a vendor branch with a single import (leaving
312 # only the 1.1 revision). If you want to retain such branches,
313 # comment out the following line. (Please note that this rule
314 # does not exclude vendor *tags*, as they are not so easy to
316 ExcludeTrivialImportBranchRule(),
318 # To exclude all vendor branches (branches that had "cvs import"s
319 # on them bug no other kinds of commits), uncomment the following
321 #ExcludeVendorBranchRule(),
323 # Usually you want this rule, to convert unambiguous symbols
324 # (symbols that were only ever used as tags or only ever used as
325 # branches in CVS) the same way they were used in CVS:
326 UnambiguousUsageRule(),
328 # If there was ever a commit on a symbol, then it cannot be
329 # converted as a tag. This rule causes all such symbols to be
330 # converted as branches. If you would like to resolve such
331 # ambiguities manually, comment out the following line:
332 BranchIfCommitsRule(),
334 # Last in the list can be a catch-all rule that is used for
335 # symbols that were not matched by any of the more specific rules
336 # above. (Assuming that BranchIfCommitsRule() was included above,
337 # then the symbols that are still indeterminate at this point can
338 # sensibly be converted as branches or tags.) Include at most one
339 # of these lines. If none of these catch-all rules are included,
340 # then the presence of any ambiguous symbols (that haven't been
341 # disambiguated above) is an error:
343 # Convert ambiguous symbols based on whether they were used more
344 # often as branches or as tags:
345 HeuristicStrategyRule(),
346 # Convert all ambiguous symbols as branches:
348 # Convert all ambiguous symbols as tags:
351 # The last rule is here to choose the preferred parent of branches
352 # and tags, that is, the line of development from which the symbol
354 HeuristicPreferredParentRule(),
357 # Specify a username to be used for commits for which CVS doesn't
358 # record the original author (for example, the creation of a branch).
359 # This should be a simple (unix-style) username, but it can be
360 # translated into a git-style name by the author_transforms map.
361 ctx.username = 'cvs2svn'
363 # ctx.svn_property_setters contains a list of rules used to set the
364 # svn properties on files in the converted archive. For each file,
365 # the rules are tried one by one. Any rule can add or suppress one or
366 # more svn properties. Typically the rules will not overwrite
367 # properties set by a previous rule (though they are free to do so).
369 # Obviously, SVN properties per se are not interesting for a cvs2git
370 # conversion, but some of these properties have side-effects that do
371 # affect the git output. FIXME: Document this in more detail.
372 ctx.svn_property_setters.extend([
373 # To read auto-props rules from a file, uncomment the following line
374 # and specify a filename. The boolean argument specifies whether
375 # case should be ignored when matching filenames to the filename
376 # patterns found in the auto-props file:
377 #AutoPropsPropertySetter(
378 # r'/home/username/.subversion/config',
382 # To read mime types from a file, uncomment the following line and
383 # specify a filename:
384 #MimeMapper(r'/etc/mime.types'),
386 # Omit the svn:eol-style property from any files that are listed
387 # as binary (i.e., mode '-kb') in CVS:
388 CVSBinaryFileEOLStyleSetter(),
390 # If the file is binary and its svn:mime-type property is not yet
391 # set, set svn:mime-type to 'application/octet-stream'.
392 CVSBinaryFileDefaultMimeTypeSetter(),
394 # To try to determine the eol-style from the mime type, uncomment
395 # the following line:
396 #EOLStyleFromMimeTypeSetter(),
398 # Choose one of the following lines to set the default
399 # svn:eol-style if none of the above rules applied. The argument
400 # is the svn:eol-style that should be applied, or None if no
401 # svn:eol-style should be set (i.e., the file should be treated as
404 # The default is to treat all files as binary unless one of the
405 # previous rules has determined otherwise, because this is the
406 # safest approach. However, if you have been diligent about
407 # marking binary files with -kb in CVS and/or you have used the
408 # above rules to definitely mark binary files as binary, then you
409 # might prefer to use 'native' as the default, as it is usually
410 # the most convenient setting for text files. Other possible
411 # options: 'CRLF', 'CR', 'LF'.
412 DefaultEOLStyleSetter(None),
413 #DefaultEOLStyleSetter('native'),
415 # Prevent svn:keywords from being set on files that have
416 # svn:eol-style unset.
417 SVNBinaryFileKeywordsPropertySetter(),
419 # If svn:keywords has not been set yet, set it based on the file's
421 KeywordsPropertySetter(config.SVN_KEYWORDS_VALUE),
423 # Set the svn:executable flag on any files that are marked in CVS as
425 ExecutablePropertySetter(),
429 # The directory to use for temporary files:
430 ctx.tmpdir = r'cvs2svn-tmp'
432 # To skip the cleanup of temporary files, uncomment the following
434 #ctx.skip_cleanup = True
437 # In CVS, it is perfectly possible to make a single commit that
438 # affects more than one project or more than one branch of a single
439 # project. Subversion also allows such commits. Therefore, by
440 # default, when cvs2svn sees what looks like a cross-project or
441 # cross-branch CVS commit, it converts it into a
442 # cross-project/cross-branch Subversion commit.
444 # However, other tools and SCMs have trouble representing
445 # cross-project or cross-branch commits. (For example, Trac's Revtree
446 # plugin, http://www.trac-hacks.org/wiki/RevtreePlugin is confused by
447 # such commits.) Therefore, we provide the following two options to
448 # allow cross-project/cross-branch commits to be suppressed.
450 # cvs2git only supports single-project conversions (multiple-project
451 # conversions wouldn't really make sense for git anyway). So this
452 # option must be set to False:
453 ctx.cross_project_commits = False
455 # git itself doesn't allow commits that affect more than one branch,
456 # so this option must be set to False:
457 ctx.cross_branch_commits = False
459 # cvs2git does not yet handle translating .cvsignore files into
460 # .git/info/exclude content, so by default, the .cvsignore files are included inthe conversion output. If you would like to omit the .cvsignore files from the output, set this option to False:
461 ctx.keep_cvsignore = True
463 # By default, it is a fatal error for a CVS ",v" file to appear both
464 # inside and outside of an "Attic" subdirectory (this should never
465 # happen, but frequently occurs due to botched repository
466 # administration). If you would like to retain both versions of such
467 # files, change the following option to True, and the attic version of
468 # the file will be written to a subdirectory called "Attic" in the
470 ctx.retain_conflicting_attic_files = False
472 # CVS uses unix login names as author names whereas git requires
473 # author names to be of the form "foo <bar>". The default is to set
474 # the git author to "cvsauthor <cvsauthor>". author_transforms can be
475 # used to map cvsauthor names (e.g., "jrandom") to a true name and
476 # email address (e.g., "J. Random <jrandom@example.com>" for the
477 # example shown). All values should be either 16-bit strings (i.e.,
478 # with "u" as a prefix) or 8-bit strings in the utf-8 encoding.
479 # Please substitute your own project's usernames here to use with the
480 # author_transforms option of GitOutputOption below.
482 'jrandom' : ('J. Random', 'jrandom@example.com'),
483 'mhagger' : ('Michael Haggerty', 'mhagger@alum.mit.edu'),
484 'brane' : (u'Branko Čibej', 'brane@xbc.nu'),
485 'ringstrom' : ('Tobias Ringström', 'tobias@ringstrom.mine.nu'),
486 'dionisos' : (u'Erik Hülsmann', 'e.huelsmann@gmx.net'),
488 # This one will be used for commits for which CVS doesn't record
489 # the original author, as explained above.
490 'cvs2svn' : ('cvs2svn', 'admin@example.com'),
493 # This is the main option that causes cvs2svn to output to git rather
495 ctx.output_option = GitOutputOption(
496 # The file in which to write the git-fast-import stream that
497 # contains the changesets and branch/tag information:
498 'cvs2svn-tmp/git-dump.dat',
500 # The blobs will be written via the revision recorder, so in
501 # OutputPass we only have to emit references to the blob marks:
502 GitRevisionMarkWriter(),
504 # This option can be set to an integer to limit the number of
505 # revisions that are merged with the main parent in any commit.
506 # For git output, this can be set to None (unlimited), though due
507 # to the limitations of other tools you might want to set it to a
508 # smaller number (e.g., 16). For Mercurial output, this should be
513 # Optional map from CVS author names to git author names:
514 author_transforms=author_transforms,
517 # Change this option to True to turn on profiling of cvs2svn (for
518 # debugging purposes):
519 run_options.profiling = False
522 # Should CVSItem -> Changeset database files be memory mapped? In
523 # some tests, using memory mapping speeded up the overall conversion
524 # by about 5%. But this option can cause the conversion to fail with
525 # an out of memory error if the conversion computer runs out of
526 # virtual address space (e.g., when running a very large conversion on
527 # a 32-bit operating system). Therefore it is disabled by default.
528 # Uncomment the following line to allow these database files to be
530 #changeset_database.use_mmap_for_cvs_item_to_changeset_table = True
532 # Now set the project to be converted to git. cvs2git only supports
533 # single-project conversions, so this method must only be called
535 run_options.set_project(
536 # The filesystem path to the part of the CVS repository (*not* a
537 # CVS working copy) that should be converted. This may be a
538 # subdirectory (i.e., a module) within a larger CVS repository.
539 r'test-data/main-cvsrepos',
541 # A list of symbol transformations that can be used to rename
542 # symbols in this project.
544 # RegexpSymbolTransforms transform symbols textually using a
545 # regular expression. The first argument is a Python regular
546 # expression pattern and the second is a replacement pattern.
547 # The pattern is matched against each symbol name. If it
548 # matches the whole symbol name, then the symbol name is
549 # replaced with the corresponding replacement text. The
550 # replacement can include substitution patterns (e.g., r'\1'
551 # or r'\g<name>'). Typically you will want to use raw strings
552 # (strings with a preceding 'r', like shown in the examples)
553 # for the regexp and its replacement to avoid backslash
554 # substitution within those strings.
556 #RegexpSymbolTransform(r'release-(\d+)_(\d+)',
558 #RegexpSymbolTransform(r'release-(\d+)_(\d+)_(\d+)',
559 # r'release-\1.\2.\3'),
561 # Simple 1:1 character replacements can also be done. The
562 # following transform converts backslashes into forward
564 ReplaceSubstringsSymbolTransform('\\','/'),
566 # This last rule eliminates leading, trailing, and repeated
567 # slashes within the output symbol names:
568 NormalizePathsSymbolTransform(),
571 # See the definition of global_symbol_strategy_rules above for a
572 # description of this option:
573 symbol_strategy_rules=global_symbol_strategy_rules,