1 # (Be in -*- mode: python; coding: utf-8 -*- mode.)
3 # ====================================================================
4 # Copyright (c) 2006-2009 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. Many options do not have defaults, so it is easier to copy
23 # this file and modify what you need rather than creating a new
24 # options file from scratch.
26 # This file is in Python syntax, but you don't need to know Python to
27 # modify it. But if you *do* know Python, then you will be happy to
28 # know that you can use arbitary Python constructs to do fancy
29 # configuration tricks.
31 # But please be aware of the following:
33 # * In many places, leading whitespace is significant in Python (it is
34 # used instead of curly braces to group statements together).
35 # Therefore, if you don't know what you are doing, it is best to
36 # leave the whitespace as it is.
38 # * In normal strings, Python treats a backslash ("\") as an escape
39 # character. Therefore, if you want to specify a string that
40 # contains a backslash, you need either to escape the backslash with
41 # another backslash ("\\"), or use a "raw string", as in one if the
42 # following equivalent examples:
44 # cvs_executable = 'c:\\windows\\system32\\cvs.exe'
45 # cvs_executable = r'c:\windows\system32\cvs.exe'
47 # See http://docs.python.org/tutorial/introduction.html#strings for
50 # Two identifiers will have been defined before this file is executed,
51 # and can be used freely within this file:
53 # ctx -- a Ctx object (see cvs2svn_lib/context.py), which holds
54 # many configuration options
56 # run_options -- an instance of the SVNRunOptions class (see
57 # cvs2svn_lib/svn_run_options.py), which holds some variables
58 # governing how cvs2svn is run
61 # Import some modules that are used in setting the options:
64 from cvs2svn_lib import config
65 from cvs2svn_lib import changeset_database
66 from cvs2svn_lib.common import CVSTextDecoder
67 from cvs2svn_lib.log import logger
68 from cvs2svn_lib.project import Project
69 from cvs2svn_lib.svn_output_option import DumpfileOutputOption
70 from cvs2svn_lib.svn_output_option import ExistingRepositoryOutputOption
71 from cvs2svn_lib.svn_output_option import NewRepositoryOutputOption
72 from cvs2svn_lib.svn_run_options import SVNEOLFixPropertySetter
73 from cvs2svn_lib.svn_run_options import SVNKeywordHandlingPropertySetter
74 from cvs2svn_lib.revision_manager import NullRevisionCollector
75 from cvs2svn_lib.rcs_revision_manager import RCSRevisionReader
76 from cvs2svn_lib.cvs_revision_manager import CVSRevisionReader
77 from cvs2svn_lib.checkout_internal import InternalRevisionCollector
78 from cvs2svn_lib.checkout_internal import InternalRevisionReader
79 from cvs2svn_lib.symbol_strategy import AllBranchRule
80 from cvs2svn_lib.symbol_strategy import AllTagRule
81 from cvs2svn_lib.symbol_strategy import BranchIfCommitsRule
82 from cvs2svn_lib.symbol_strategy import ExcludeRegexpStrategyRule
83 from cvs2svn_lib.symbol_strategy import ForceBranchRegexpStrategyRule
84 from cvs2svn_lib.symbol_strategy import ForceTagRegexpStrategyRule
85 from cvs2svn_lib.symbol_strategy import ExcludeTrivialImportBranchRule
86 from cvs2svn_lib.symbol_strategy import ExcludeVendorBranchRule
87 from cvs2svn_lib.symbol_strategy import HeuristicStrategyRule
88 from cvs2svn_lib.symbol_strategy import UnambiguousUsageRule
89 from cvs2svn_lib.symbol_strategy import HeuristicPreferredParentRule
90 from cvs2svn_lib.symbol_strategy import SymbolHintsFileRule
91 from cvs2svn_lib.symbol_transform import ReplaceSubstringsSymbolTransform
92 from cvs2svn_lib.symbol_transform import RegexpSymbolTransform
93 from cvs2svn_lib.symbol_transform import IgnoreSymbolTransform
94 from cvs2svn_lib.symbol_transform import NormalizePathsSymbolTransform
95 from cvs2svn_lib.property_setters import AutoPropsPropertySetter
96 from cvs2svn_lib.property_setters import CVSBinaryFileDefaultMimeTypeSetter
97 from cvs2svn_lib.property_setters import CVSBinaryFileEOLStyleSetter
98 from cvs2svn_lib.property_setters import CVSRevisionNumberSetter
99 from cvs2svn_lib.property_setters import DefaultEOLStyleSetter
100 from cvs2svn_lib.property_setters import EOLStyleFromMimeTypeSetter
101 from cvs2svn_lib.property_setters import ExecutablePropertySetter
102 from cvs2svn_lib.property_setters import DescriptionPropertySetter
103 from cvs2svn_lib.property_setters import KeywordsPropertySetter
104 from cvs2svn_lib.property_setters import MimeMapper
105 from cvs2svn_lib.property_setters import SVNBinaryFileKeywordsPropertySetter
107 # To choose the level of logging output, uncomment one of the
109 #logger.log_level = logger.WARN
110 #logger.log_level = logger.QUIET
111 logger.log_level = logger.NORMAL
112 #logger.log_level = logger.VERBOSE
113 #logger.log_level = logger.DEBUG
116 # The directory to use for temporary files:
117 ctx.tmpdir = r'cvs2svn-tmp'
119 # author_transforms can be used to map CVS author names (e.g.,
120 # "jrandom") to whatever names make sense for your SVN configuration
121 # (e.g., "john.j.random"). All values should be either Unicode
122 # strings (i.e., with "u" as a prefix) or 8-bit strings in the utf-8
123 # encoding. To use this feature, please substitute your own project's
124 # usernames here and uncomment the author_transforms option when
125 # setting ctx.output_option below
127 'jrandom' : u'john.j.random',
128 'brane' : u'Branko.Čibej',
129 'ringstrom' : 'ringström',
130 'dionisos' : u'e.hülsmann',
133 # There are several possible options for where to put the output of a
134 # cvs2svn conversion. Please choose one of the following and adjust
135 # the parameters as necessary:
137 # Use this output option if you would like cvs2svn to create a new SVN
138 # repository and store the converted repository there. The first
139 # argument is the path to which the repository should be written (this
140 # repository must not already exist). The (optional) fs_type argument
141 # allows a --fs-type option to be passed to "svnadmin create". The
142 # (optional) bdb_txn_nosync argument can be specified to set the
143 # --bdb-txn-nosync option on a bdb repository. The (optional)
144 # create_options argument can be specified to set a list of verbatim
145 # options to be passed to "svnadmin create". The (optional)
146 # author_transforms argument allows CVS author names to be transformed
147 # arbitrarily into SVN author names (as described above):
148 ctx.output_option = NewRepositoryOutputOption(
151 #bdb_txn_nosync=False,
152 #create_options=['--pre-1.5-compatible'],
153 #author_transforms=author_transforms,
156 # Use this output option if you would like cvs2svn to store the
157 # converted CVS repository into an SVN repository that already exists.
158 # The first argument is the filesystem path of an existing local SVN
159 # repository (this repository must already exist). The
160 # author_transforms option is as described above:
161 #ctx.output_option = ExistingRepositoryOutputOption(
162 # r'/path/to/svnrepo', # Path to repository
163 # #author_transforms=author_transforms,
166 # Use this type of output option if you want the output of the
167 # conversion to be written to a SVN dumpfile instead of committing
168 # them into an actual repository. The author_transforms option is as
170 #ctx.output_option = DumpfileOutputOption(
171 # dumpfile_path=r'/path/to/cvs2svn-dump', # Name of dumpfile to create
172 # #author_transforms=author_transforms,
176 # Independent of the ctx.output_option selected, the following option
177 # can be set to True to suppress cvs2svn output altogether:
180 # The following set of options specifies how the revision contents of
181 # the RCS files should be read.
183 # The default selection is InternalRevisionReader, which uses built-in
184 # code that reads the RCS deltas while parsing the files in
185 # CollectRevsPass. This method is very fast but requires lots of
186 # temporary disk space. The disk space is required for (1) storing
187 # all of the RCS deltas, and (2) during OutputPass, keeping a copy of
188 # the full text of every revision that still has a descendant that
189 # hasn't yet been committed. Since this can includes multiple
190 # revisions of each file (i.e., on multiple branches), the required
191 # amount of temporary space can potentially be many times the size of
192 # a checked out copy of the whole repository. Setting compress=True
193 # cuts the disk space requirements by about 50% at the price of
194 # increased CPU usage. Using compression usually speeds up the
195 # conversion due to the reduced I/O pressure, unless --tmpdir is on a
196 # RAM disk. This method does not expand CVS's "Log" keywords.
198 # The second possibility is RCSRevisionReader, which uses RCS's "co"
199 # program to extract the revision contents of the RCS files during
200 # OutputPass. This option doesn't require any temporary space, but it
201 # is relatively slow because (1) "co" has to be executed very many
202 # times; and (2) "co" itself has to assemble many file deltas to
203 # compute the contents of a particular revision. The constructor
204 # argument specifies how to invoke the "co" executable.
206 # The third possibility is CVSRevisionReader, which uses the "cvs"
207 # program to extract the revision contents out of the RCS files during
208 # OutputPass. This option doesn't require any temporary space, but it
209 # is the slowest of all, because "cvs" is considerably slower than
210 # "co". However, it works in some situations where RCSRevisionReader
211 # fails; see the HTML documentation of the "--use-cvs" option for
212 # details. The constructor argument specifies how to invoke the "co"
215 # Choose one of the following three groups of lines:
216 ctx.revision_collector = InternalRevisionCollector(compress=True)
217 ctx.revision_reader = InternalRevisionReader(compress=True)
219 #ctx.revision_collector = NullRevisionCollector()
220 #ctx.revision_reader = RCSRevisionReader(co_executable=r'co')
222 #ctx.revision_collector = NullRevisionCollector()
223 #ctx.revision_reader = CVSRevisionReader(cvs_executable=r'cvs')
225 # Set the name (and optionally the path) to the 'svnadmin' command,
226 # which is needed for NewRepositoryOutputOption or
227 # ExistingRepositoryOutputOption. The default is the "svnadmin"
228 # command in the user's PATH:
229 #ctx.svnadmin_executable = r'svnadmin'
231 # Change the following line to True if the conversion should only
232 # include the trunk of the repository (i.e., all branches and tags
233 # should be ignored):
234 ctx.trunk_only = False
236 # Normally, cvs2svn ignores directories within the CVS repository if
237 # they do not contain valid RCS files. This produces a Subversion
238 # repository whose behavior imitates that of CVS if CVS is typically
239 # used with the "-P" option. However, sometimes these empty
240 # directories are needed by a project (e.g., by the build procedure).
241 # If so, the following option can be sent to True to cause empty
242 # directories to be created in the SVN repository when their parent
243 # directory is created and removed when their parent directory is
244 # removed. (This is more likely to be useful than the behavior of CVS
245 # when its "-P" option is not used.)
246 ctx.include_empty_directories = False
248 # Normally, cvs2svn deletes a directory once the last file has been
249 # deleted from it (a la "cvs -P"). Change the following line to False
250 # if you would like such directories to be retained in the Subversion
251 # repository through the rest of history:
254 # How to convert author names, log messages, and filenames to Unicode.
255 # The first argument to CVSTextDecoder is a list of encoders that are
256 # tried in order in 'strict' mode until one of them succeeds. If none
257 # of those succeeds, then fallback_encoder is used in lossy 'replace'
258 # mode (if it is specified). Setting a fallback encoder ensures that
259 # the encoder always succeeds, but it can cause information loss.
260 ctx.cvs_author_decoder = CVSTextDecoder(
266 #fallback_encoding='ascii'
268 ctx.cvs_log_decoder = CVSTextDecoder(
274 #fallback_encoding='ascii',
277 # You might want to be especially strict when converting filenames to
278 # Unicode (e.g., maybe not specify a fallback_encoding).
279 ctx.cvs_filename_decoder = CVSTextDecoder(
285 #fallback_encoding='ascii'
288 # Template for the commit message to be used for initial project
290 ctx.initial_project_commit_message = (
291 'Standard project directories initialized by cvs2svn.'
294 # Template for the commit message to be used for post commits, in
295 # which modifications to a vendor branch are copied back to trunk.
296 # This message can use '%(revnum)d' to include the revision number of
297 # the revision that included the change to the vendor branch.
298 ctx.post_commit_message = (
299 'This commit was generated by cvs2svn to compensate for '
300 'changes in r%(revnum)d, which included commits to RCS files '
301 'with non-trunk default branches.'
304 # Template for the commit message to be used for commits in which
305 # symbols are created. This message can use '%(symbol_type)s' to
306 # include the type of the symbol ('branch' or 'tag') or
307 # '%(symbol_name)s' to include the name of the symbol.
308 ctx.symbol_commit_message = (
309 "This commit was manufactured by cvs2svn to create %(symbol_type)s "
313 # Some CVS clients for MacOS store resource fork data into CVS along
314 # with the file contents itself by wrapping it all up in a container
315 # format called "AppleSingle". Subversion currently does not support
316 # MacOS resource forks. Nevertheless, sometimes the resource fork
317 # information is not necessary and can be discarded. Set the
318 # following option to True if you would like cvs2svn to identify files
319 # whose contents are encoded in AppleSingle format, and discard all
320 # but the data fork for such files before committing them to
321 # Subversion. (Please note that AppleSingle contents are identified
322 # by the AppleSingle magic number as the first four bytes of the file.
323 # This check is not failproof, so only set this option if you think
325 ctx.decode_apple_single = False
327 # This option can be set to the name of a filename to which are stored
328 # statistics and conversion decisions about the CVS symbols.
329 ctx.symbol_info_filename = None
330 #ctx.symbol_info_filename = 'symbol-info.txt'
332 # cvs2svn uses "symbol strategy rules" to help decide how to handle
333 # CVS symbols. The rules in a project's symbol_strategy_rules are
334 # applied in order, and each rule is allowed to modify the symbol.
335 # The result (after each of the rules has been applied) is used for
338 # 1. A CVS symbol might be used as a tag in one file and as a branch
339 # in another file. cvs2svn has to decide whether to convert such a
340 # symbol as a tag or as a branch. cvs2svn uses a series of
341 # heuristic rules to decide how to convert a symbol. The user can
342 # override the default rules for specific symbols or symbols
343 # matching regular expressions.
345 # 2. cvs2svn is also capable of excluding symbols from the conversion
346 # (provided no other symbols depend on them.
348 # 3. CVS does not record unambiguously the line of development from
349 # which a symbol sprouted. cvs2svn uses a heuristic to choose a
350 # symbol's "preferred parents".
352 # The standard branch/tag/exclude StrategyRules do not change a symbol
353 # that has already been processed by an earlier rule, so in effect the
354 # first matching rule is the one that is used.
356 global_symbol_strategy_rules = [
357 # It is possible to specify manually exactly how symbols should be
358 # converted and what line of development should be used as the
359 # preferred parent. To do so, create a file containing the symbol
360 # hints and enable the following option.
362 # The format of the hints file is described in the documentation
363 # for the SymbolHintsFileRule class in
364 # cvs2svn_lib/symbol_strategy.py. The file output by the
365 # --write-symbol-info (i.e., ctx.symbol_info_filename) option is
366 # in the same format. The simplest way to use this option is to
367 # run the conversion through CollateSymbolsPass with
368 # --write-symbol-info option, copy the symbol info and edit it to
369 # create a hints file, then re-start the conversion at
370 # CollateSymbolsPass with this option enabled.
371 #SymbolHintsFileRule('symbol-hints.txt'),
373 # To force all symbols matching a regular expression to be
374 # converted as branches, add rules like the following:
375 #ForceBranchRegexpStrategyRule(r'branch.*'),
377 # To force all symbols matching a regular expression to be
378 # converted as tags, add rules like the following:
379 #ForceTagRegexpStrategyRule(r'tag.*'),
381 # To force all symbols matching a regular expression to be
382 # excluded from the conversion, add rules like the following:
383 #ExcludeRegexpStrategyRule(r'unknown-.*'),
385 # Sometimes people use "cvs import" to get their own source code
386 # into CVS. This practice creates a vendor branch 1.1.1 and
387 # imports the code onto the vendor branch as 1.1.1.1, then copies
388 # the same content to the trunk as version 1.1. Normally, such
389 # vendor branches are useless and they complicate the SVN history
390 # unnecessarily. The following rule excludes any branches that
391 # only existed as a vendor branch with a single import (leaving
392 # only the 1.1 revision). If you want to retain such branches,
393 # comment out the following line. (Please note that this rule
394 # does not exclude vendor *tags*, as they are not so easy to
396 ExcludeTrivialImportBranchRule(),
398 # To exclude all vendor branches (branches that had "cvs import"s
399 # on them but no other kinds of commits), uncomment the following
401 #ExcludeVendorBranchRule(),
403 # Usually you want this rule, to convert unambiguous symbols
404 # (symbols that were only ever used as tags or only ever used as
405 # branches in CVS) the same way they were used in CVS:
406 UnambiguousUsageRule(),
408 # If there was ever a commit on a symbol, then it cannot be
409 # converted as a tag. This rule causes all such symbols to be
410 # converted as branches. If you would like to resolve such
411 # ambiguities manually, comment out the following line:
412 BranchIfCommitsRule(),
414 # Last in the list can be a catch-all rule that is used for
415 # symbols that were not matched by any of the more specific rules
416 # above. (Assuming that BranchIfCommitsRule() was included above,
417 # then the symbols that are still indeterminate at this point can
418 # sensibly be converted as branches or tags.) Include at most one
419 # of these lines. If none of these catch-all rules are included,
420 # then the presence of any ambiguous symbols (that haven't been
421 # disambiguated above) is an error:
423 # Convert ambiguous symbols based on whether they were used more
424 # often as branches or as tags:
425 HeuristicStrategyRule(),
426 # Convert all ambiguous symbols as branches:
428 # Convert all ambiguous symbols as tags:
431 # The last rule is here to choose the preferred parent of branches
432 # and tags, that is, the line of development from which the symbol
434 HeuristicPreferredParentRule(),
437 # Specify a username to be used for commits generated by cvs2svn. If
438 # this option is set to None then no username will be used for such
441 #ctx.username = 'cvs2svn'
443 # ctx.file_property_setters and ctx.revision_property_setters contain
444 # rules used to set the svn properties on files in the converted
445 # archive. For each file, the rules are tried one by one. Any rule
446 # can add or suppress one or more svn properties. Typically the rules
447 # will not overwrite properties set by a previous rule (though they
448 # are free to do so). ctx.file_property_setters should be used for
449 # properties that remain the same for the life of the file; these
450 # should implement FilePropertySetter. ctx.revision_property_setters
451 # should be used for properties that are allowed to vary from revision
452 # to revision; these should implement RevisionPropertySetter.
453 ctx.file_property_setters.extend([
454 # To read auto-props rules from a file, uncomment the following line
455 # and specify a filename. The boolean argument specifies whether
456 # case should be ignored when matching filenames to the filename
457 # patterns found in the auto-props file:
458 #AutoPropsPropertySetter(
459 # r'/home/username/.subversion/config',
463 # To read mime types from a file and use them to set svn:mime-type
464 # based on the filename extensions, uncomment the following line
465 # and specify a filename (see
466 # http://en.wikipedia.org/wiki/Mime.types for information about
468 #MimeMapper(r'/etc/mime.types', ignore_case=False),
470 # Omit the svn:eol-style property from any files that are listed
471 # as binary (i.e., mode '-kb') in CVS:
472 CVSBinaryFileEOLStyleSetter(),
474 # If the file is binary and its svn:mime-type property is not yet
475 # set, set svn:mime-type to 'application/octet-stream'.
476 CVSBinaryFileDefaultMimeTypeSetter(),
478 # To try to determine the eol-style from the mime type, uncomment
479 # the following line:
480 #EOLStyleFromMimeTypeSetter(),
482 # Choose one of the following lines to set the default
483 # svn:eol-style if none of the above rules applied. The argument
484 # is the svn:eol-style that should be applied, or None if no
485 # svn:eol-style should be set (i.e., the file should be treated as
488 # The default is to treat all files as binary unless one of the
489 # previous rules has determined otherwise, because this is the
490 # safest approach. However, if you have been diligent about
491 # marking binary files with -kb in CVS and/or you have used the
492 # above rules to definitely mark binary files as binary, then you
493 # might prefer to use 'native' as the default, as it is usually
494 # the most convenient setting for text files. Other possible
495 # options: 'CRLF', 'CR', 'LF'.
496 DefaultEOLStyleSetter(None),
497 #DefaultEOLStyleSetter('native'),
499 # Prevent svn:keywords from being set on files that have
500 # svn:eol-style unset.
501 SVNBinaryFileKeywordsPropertySetter(),
503 # If svn:keywords has not been set yet, set it based on the file's
505 KeywordsPropertySetter(config.SVN_KEYWORDS_VALUE),
507 # Set the svn:executable flag on any files that are marked in CVS as
509 ExecutablePropertySetter(),
511 # Set the cvs:description property to the CVS description of any
513 DescriptionPropertySetter(propname='cvs:description'),
515 # The following is for internal use. It determines how to handle
516 # keywords in the text being committed:
517 SVNKeywordHandlingPropertySetter(),
519 # The following is for internal use. It determines how to munge
520 # EOL sequences based on how the svn:eol-style property is set.
521 SVNEOLFixPropertySetter(),
524 ctx.revision_property_setters.extend([
525 # Uncomment the following line to include the original CVS revision
526 # numbers as file properties in the SVN archive:
527 #CVSRevisionNumberSetter(propname='cvs2svn:cvs-rev'),
531 # To skip the cleanup of temporary files, uncomment the following
533 #ctx.skip_cleanup = True
536 # In CVS, it is perfectly possible to make a single commit that
537 # affects more than one project or more than one branch of a single
538 # project. Subversion also allows such commits. Therefore, by
539 # default, when cvs2svn sees what looks like a cross-project or
540 # cross-branch CVS commit, it converts it into a
541 # cross-project/cross-branch Subversion commit.
543 # However, other tools and SCMs have trouble representing
544 # cross-project or cross-branch commits. (For example, Trac's Revtree
545 # plugin, http://www.trac-hacks.org/wiki/RevtreePlugin is confused by
546 # such commits.) Therefore, we provide the following two options to
547 # allow cross-project/cross-branch commits to be suppressed.
549 # To prevent CVS commits from different projects from being merged
550 # into single SVN commits, change this option to False:
551 ctx.cross_project_commits = True
553 # To prevent CVS commits on different branches from being merged into
554 # single SVN commits, change this option to False:
555 ctx.cross_branch_commits = True
557 # By default, .cvsignore files are rendered in the output by setting
558 # corresponding svn:ignore properties on the parent directory, but the
559 # .cvsignore files themselves are not included in the conversion
560 # output. If you would like to include the .cvsignore files in the
561 # output, change this option to True:
562 ctx.keep_cvsignore = False
564 # By default, it is a fatal error for a CVS ",v" file to appear both
565 # inside and outside of an "Attic" subdirectory (this should never
566 # happen, but frequently occurs due to botched repository
567 # administration). If you would like to retain both versions of such
568 # files, change the following option to True, and the attic version of
569 # the file will be left in an SVN subdirectory called "Attic":
570 ctx.retain_conflicting_attic_files = False
572 # Now use stanzas like the following to define CVS projects that
573 # should be converted. The arguments are:
575 # - The filesystem path of the project within the CVS repository.
577 # - The path that should be used for the "trunk" directory of this
578 # project within the SVN repository. This is an SVN path, so it
579 # should always use forward slashes ("/").
581 # - The path that should be used for the "branches" directory of this
582 # project within the SVN repository. This is an SVN path, so it
583 # should always use forward slashes ("/").
585 # - The path that should be used for the "tags" directory of this
586 # project within the SVN repository. This is an SVN path, so it
587 # should always use forward slashes ("/").
589 # - A list of symbol transformations that can be used to rename
590 # symbols in this project. Each entry is a tuple (pattern,
591 # replacement), where pattern is a Python regular expression pattern
592 # and replacement is the text that should replace the pattern. Each
593 # pattern is matched against each symbol name. If the pattern
594 # matches, then it is replaced with the corresponding replacement
595 # text. The replacement can include substitution patterns (e.g.,
596 # r'\1' or r'\g<name>'). Typically you will want to use raw strings
597 # (strings with a preceding 'r', like shown in the examples) for the
598 # regexp and its replacement to avoid backslash substitution within
602 # Create the default project (using ctx.trunk, ctx.branches, and ctx.tags):
603 run_options.add_project(
604 r'test-data/main-cvsrepos',
606 branches_path='branches',
608 initial_directories=[
609 # The project's trunk_path, branches_path, and tags_path
610 # directories are added to the SVN repository in the project's
611 # first commit. If you would like additional SVN directories
612 # to be created in the project's first commit, list them here:
616 # Use IgnoreSymbolTransforms like the following to completely
617 # ignore symbols matching a regular expression when parsing
618 # the CVS repository, for example to avoid warnings about
619 # branches with two names and to choose the preferred name.
620 # It is *not* recommended to use this instead of
621 # ExcludeRegexpStrategyRule; though more efficient,
622 # IgnoreSymbolTransforms are less flexible and don't exclude
623 # branches correctly. The argument is a Python-style regular
624 # expression that has to match the *whole* CVS symbol name:
625 #IgnoreSymbolTransform(r'nightly-build-tag-.*')
627 # RegexpSymbolTransforms transform symbols textually using a
628 # regular expression. The first argument is a Python regular
629 # expression pattern and the second is a replacement pattern.
630 # The pattern is matched against each symbol name. If it
631 # matches the whole symbol name, then the symbol name is
632 # replaced with the corresponding replacement text. The
633 # replacement can include substitution patterns (e.g., r'\1'
634 # or r'\g<name>'). Typically you will want to use raw strings
635 # (strings with a preceding 'r', like shown in the examples)
636 # for the regexp and its replacement to avoid backslash
637 # substitution within those strings.
638 #RegexpSymbolTransform(r'release-(\d+)_(\d+)',
640 #RegexpSymbolTransform(r'release-(\d+)_(\d+)_(\d+)',
641 # r'release-\1.\2.\3'),
643 # Simple 1:1 character replacements can also be done. The
644 # following transform, which converts backslashes into forward
645 # slashes, should usually be included:
646 ReplaceSubstringsSymbolTransform('\\','/'),
648 # Eliminate leading, trailing, and repeated slashes. This
649 # transform should always be included:
650 NormalizePathsSymbolTransform(),
652 symbol_strategy_rules=[
653 # Additional, project-specific symbol strategy rules can
655 ] + global_symbol_strategy_rules,
657 # Exclude paths from the conversion. Should be relative to
658 # repository path and use forward slashes:
659 #exclude_paths=['file-to-exclude.txt,v', 'dir/to/exclude'],
662 # Add a second project, to be stored to projA/trunk, projA/branches,
664 #run_options.add_project(
665 # r'my/cvsrepo/projA',
666 # trunk_path='projA/trunk',
667 # branches_path='projA/branches',
668 # tags_path='projA/tags',
669 # initial_directories=[
671 # symbol_transforms=[
672 # #RegexpSymbolTransform(r'release-(\d+)_(\d+)',
673 # # r'release-\1.\2'),
674 # #RegexpSymbolTransform(r'release-(\d+)_(\d+)_(\d+)',
675 # # r'release-\1.\2.\3'),
676 # ReplaceSubstringsSymbolTransform('\\','/'),
677 # NormalizePathsSymbolTransform(),
679 # symbol_strategy_rules=[
680 # # Additional, project-specific symbol strategy rules can
682 # ] + global_symbol_strategy_rules,
685 # Change this option to True to turn on profiling of cvs2svn (for
686 # debugging purposes):
687 run_options.profiling = False
690 # Should CVSItem -> Changeset database files be memory mapped? In
691 # some tests, using memory mapping speeded up the overall conversion
692 # by about 5%. But this option can cause the conversion to fail with
693 # an out of memory error if the conversion computer runs out of
694 # virtual address space (e.g., when running a very large conversion on
695 # a 32-bit operating system). Therefore it is disabled by default.
696 # Uncomment the following line to allow these database files to be
698 #changeset_database.use_mmap_for_cvs_item_to_changeset_table = True