* www/faq.html: Make line spacing more uniform.
[cvs2svn.git] / cvs2svn-example.options
blob01a38beb82181a86a321022e729f67d5bf3eee87
1 # (Be in -*- python -*- 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.  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 #       ctx.sort_executable = 'c:\\windows\\system32\\sort.exe'
45 #       ctx.sort_executable = r'c:\windows\system32\sort.exe'
47 #   See http://docs.python.org/tutorial/introduction.html#strings for
48 #   more information.
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:
62 import re
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 Log
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.revision_manager import NullRevisionRecorder
73 from cvs2svn_lib.revision_manager import NullRevisionExcluder
74 from cvs2svn_lib.rcs_revision_manager import RCSRevisionReader
75 from cvs2svn_lib.cvs_revision_manager import CVSRevisionReader
76 from cvs2svn_lib.checkout_internal import InternalRevisionRecorder
77 from cvs2svn_lib.checkout_internal import InternalRevisionExcluder
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 KeywordsPropertySetter
103 from cvs2svn_lib.property_setters import MimeMapper
104 from cvs2svn_lib.property_setters import SVNBinaryFileKeywordsPropertySetter
106 # To choose the level of logging output, uncomment one of the
107 # following lines:
108 #Log().log_level = Log.WARN
109 #Log().log_level = Log.QUIET
110 Log().log_level = Log.NORMAL
111 #Log().log_level = Log.VERBOSE
112 #Log().log_level = Log.DEBUG
115 # There are several possible options for where to put the output of a
116 # cvs2svn conversion.  Please choose one of the following and adjust
117 # the parameters as necessary:
119 # Use this output option if you would like cvs2svn to create a new SVN
120 # repository and store the converted repository there.  The first
121 # argument is the path to which the repository should be written (this
122 # repository must not already exist).  The second (optional) argument
123 # allows a --fs-type option to be passed to "svnadmin create".  The
124 # third (optional) argument can be specified to set the
125 # --bdb-txn-nosync option on a bdb repository.  The fourth (optional)
126 # argument can be specified to set a list of verbatim options to be passed
127 # to "svnadmin create":
128 ctx.output_option = NewRepositoryOutputOption(
129     r'/path/to/svnrepo', # Path to repository
130     #fs_type='fsfs', # Type of repository to create
131     #bdb_txn_nosync=False, # For bsd repositories, this option can be added
132     #create_options=['--pre-1.5-compatible'], # Options for "svnadmin create"
133     )
135 # Use this output option if you would like cvs2svn to store the
136 # converted CVS repository into an SVN repository that already exists.
137 # The argument is the filesystem path of an existing local SVN
138 # repository (this repository must already exist):
139 #ctx.output_option = ExistingRepositoryOutputOption(
140 #    r'/path/to/svnrepo', # Path to repository
141 #    )
143 # Use this type of output option if you want the output of the
144 # conversion to be written to a SVN dumpfile instead of committing
145 # them into an actual repository:
146 #ctx.output_option = DumpfileOutputOption(
147 #    dumpfile_path=r'/path/to/cvs2svn-dump', # Name of dumpfile to create
148 #    )
151 # Independent of the ctx.output_option selected, the following option
152 # can be set to True to suppress cvs2svn output altogether:
153 ctx.dry_run = False
155 # The following set of options specifies how the revision contents of
156 # the RCS files should be read.
158 # The default selection is InternalRevisionReader, which uses built-in
159 # code that reads the RCS deltas while parsing the files in
160 # CollectRevsPass.  This method is very fast but requires lots of
161 # temporary disk space.  The disk space is required for (1) storing
162 # all of the RCS deltas, and (2) during OutputPass, keeping a copy of
163 # the full text of every revision that still has a descendant that
164 # hasn't yet been committed.  Since this can includes multiple
165 # revisions of each file (i.e., on multiple branches), the required
166 # amount of temporary space can potentially be many times the size of
167 # a checked out copy of the whole repository.  Setting compress=True
168 # cuts the disk space requirements by about 50% at the price of
169 # increased CPU usage.  Using compression usually speeds up the
170 # conversion due to the reduced I/O pressure, unless --tmpdir is on a
171 # RAM disk.  This method does not expand CVS's "Log" keywords.
173 # The second possibility is RCSRevisionReader, which uses RCS's "co"
174 # program to extract the revision contents of the RCS files during
175 # OutputPass.  This option doesn't require any temporary space, but it
176 # is relatively slow because (1) "co" has to be executed very many
177 # times; and (2) "co" itself has to assemble many file deltas to
178 # compute the contents of a particular revision.  The constructor
179 # argument specifies how to invoke the "co" executable.
181 # The third possibility is CVSRevisionReader, which uses the "cvs"
182 # program to extract the revision contents out of the RCS files during
183 # OutputPass.  This option doesn't require any temporary space, but it
184 # is the slowest of all, because "cvs" is considerably slower than
185 # "co".  However, it works in some situations where RCSRevisionReader
186 # fails; see the HTML documentation of the "--use-cvs" option for
187 # details.  The constructor argument specifies how to invoke the "co"
188 # executable.
190 # Choose one of the following three groups of lines:
191 ctx.revision_recorder = InternalRevisionRecorder(compress=True)
192 ctx.revision_excluder = InternalRevisionExcluder()
193 ctx.revision_reader = InternalRevisionReader(compress=True)
195 #ctx.revision_recorder = NullRevisionRecorder()
196 #ctx.revision_excluder = NullRevisionExcluder()
197 #ctx.revision_reader = RCSRevisionReader(co_executable=r'co')
199 #ctx.revision_recorder = NullRevisionRecorder()
200 #ctx.revision_excluder = NullRevisionExcluder()
201 #ctx.revision_reader = CVSRevisionReader(cvs_executable=r'cvs')
203 # Set the name (and optionally the path) of some other executables
204 # required by cvs2svn:
205 ctx.svnadmin_executable = r'svnadmin'
206 ctx.sort_executable = r'sort'
208 # Change the following line to True if the conversion should only
209 # include the trunk of the repository (i.e., all branches and tags
210 # should be ignored):
211 ctx.trunk_only = False
213 # Change the following line to True if cvs2svn should delete a
214 # directory once the last file has been deleted from it:
215 ctx.prune = False
217 # How to convert author names, log messages, and filenames to unicode.
218 # The first argument to CVSTextDecoder is a list of encoders that are
219 # tried in order in 'strict' mode until one of them succeeds.  If none
220 # of those succeeds, then fallback_encoder is used in lossy 'replace'
221 # mode (if it is specified).  Setting a fallback encoder ensures that
222 # the encoder always succeeds, but it can cause information loss.
223 ctx.cvs_author_decoder = CVSTextDecoder(
224     [
225         #'latin1',
226         #'utf8',
227         'ascii',
228         ],
229     #fallback_encoding='ascii'
230     )
231 ctx.cvs_log_decoder = CVSTextDecoder(
232     [
233         #'latin1',
234         #'utf8',
235         'ascii',
236         ],
237     #fallback_encoding='ascii'
238     )
239 # You might want to be especially strict when converting filenames to
240 # unicode (e.g., maybe not specify a fallback_encoding).
241 ctx.cvs_filename_decoder = CVSTextDecoder(
242     [
243         #'latin1',
244         #'utf8',
245         'ascii',
246         ],
247     #fallback_encoding='ascii'
248     )
250 # Template for the commit message to be used for initial project
251 # commits.
252 ctx.initial_project_commit_message = (
253     'Standard project directories initialized by cvs2svn.'
254     )
256 # Template for the commit message to be used for post commits, in
257 # which modifications to a vendor branch are copied back to trunk.
258 # This message can use '%(revnum)d' to include the revision number of
259 # the revision that included the change to the vendor branch.
260 ctx.post_commit_message = (
261     'This commit was generated by cvs2svn to compensate for '
262     'changes in r%(revnum)d, which included commits to RCS files '
263     'with non-trunk default branches.'
264     )
266 # Template for the commit message to be used for commits in which
267 # symbols are created.  This message can use '%(symbol_type)d' to
268 # include the type of the symbol ('branch' or 'tag') or
269 # '%(symbol_name)' to include the name of the symbol.
270 ctx.symbol_commit_message = (
271     "This commit was manufactured by cvs2svn to create %(symbol_type)s "
272     "'%(symbol_name)s'."
273     )
275 # Some CVS clients for MacOS store resource fork data into CVS along
276 # with the file contents itself by wrapping it all up in a container
277 # format called "AppleSingle".  Subversion currently does not support
278 # MacOS resource forks.  Nevertheless, sometimes the resource fork
279 # information is not necessary and can be discarded.  Set the
280 # following option to True if you would like cvs2svn to identify files
281 # whose contents are encoded in AppleSingle format, and discard all
282 # but the data fork for such files before committing them to
283 # Subversion.  (Please note that AppleSingle contents are identified
284 # by the AppleSingle magic number as the first four bytes of the file.
285 # This check is not failproof, so only set this option if you think
286 # you need it.)
287 ctx.decode_apple_single = False
289 # This option can be set to the name of a filename to which are stored
290 # statistics and conversion decisions about the CVS symbols.
291 ctx.symbol_info_filename = None
292 #ctx.symbol_info_filename = 'symbol-info.txt'
294 # cvs2svn uses "symbol strategy rules" to help decide how to handle
295 # CVS symbols.  The rules in a project's symbol_strategy_rules are
296 # applied in order, and each rule is allowed to modify the symbol.
297 # The result (after each of the rules has been applied) is used for
298 # the conversion.
300 # 1. A CVS symbol might be used as a tag in one file and as a branch
301 #    in another file.  cvs2svn has to decide whether to convert such a
302 #    symbol as a tag or as a branch.  cvs2svn uses a series of
303 #    heuristic rules to decide how to convert a symbol.  The user can
304 #    override the default rules for specific symbols or symbols
305 #    matching regular expressions.
307 # 2. cvs2svn is also capable of excluding symbols from the conversion
308 #    (provided no other symbols depend on them.
310 # 3. CVS does not record unambiguously the line of development from
311 #    which a symbol sprouted.  cvs2svn uses a heuristic to choose a
312 #    symbol's "preferred parents".
314 # The standard branch/tag/exclude StrategyRules do not change a symbol
315 # that has already been processed by an earlier rule, so in effect the
316 # first matching rule is the one that is used.
318 global_symbol_strategy_rules = [
319     # It is possible to specify manually exactly how symbols should be
320     # converted and what line of development should be used as the
321     # preferred parent.  To do so, create a file containing the symbol
322     # hints and enable the following option.
323     #
324     # The format of the hints file is described in the documentation
325     # for the SymbolHintsFileRule class in
326     # cvs2svn_lib/symbol_strategy.py.  The file output by the
327     # --write-symbol-info (i.e., ctx.symbol_info_filename) option is
328     # in the same format.  The simplest way to use this option is to
329     # run the conversion through CollateSymbolsPass with
330     # --write-symbol-info option, copy the symbol info and edit it to
331     # create a hints file, then re-start the conversion at
332     # CollateSymbolsPass with this option enabled.
333     #SymbolHintsFileRule('symbol-hints.txt'),
335     # To force all symbols matching a regular expression to be
336     # converted as branches, add rules like the following:
337     #ForceBranchRegexpStrategyRule(r'branch.*'),
339     # To force all symbols matching a regular expression to be
340     # converted as tags, add rules like the following:
341     #ForceTagRegexpStrategyRule(r'tag.*'),
343     # To force all symbols matching a regular expression to be
344     # excluded from the conversion, add rules like the following:
345     #ExcludeRegexpStrategyRule(r'unknown-.*'),
347     # Sometimes people use "cvs import" to get their own source code
348     # into CVS.  This practice creates a vendor branch 1.1.1 and
349     # imports the code onto the vendor branch as 1.1.1.1, then copies
350     # the same content to the trunk as version 1.1.  Normally, such
351     # vendor branches are useless and they complicate the SVN history
352     # unnecessarily.  The following rule excludes any branches that
353     # only existed as a vendor branch with a single import (leaving
354     # only the 1.1 revision).  If you want to retain such branches,
355     # comment out the following line.  (Please note that this rule
356     # does not exclude vendor *tags*, as they are not so easy to
357     # identify.)
358     ExcludeTrivialImportBranchRule(),
360     # To exclude all vendor branches (branches that had "cvs import"s
361     # on them bug no other kinds of commits), uncomment the following
362     # line:
363     #ExcludeVendorBranchRule(),
365     # Usually you want this rule, to convert unambiguous symbols
366     # (symbols that were only ever used as tags or only ever used as
367     # branches in CVS) the same way they were used in CVS:
368     UnambiguousUsageRule(),
370     # If there was ever a commit on a symbol, then it cannot be
371     # converted as a tag.  This rule causes all such symbols to be
372     # converted as branches.  If you would like to resolve such
373     # ambiguities manually, comment out the following line:
374     BranchIfCommitsRule(),
376     # Last in the list can be a catch-all rule that is used for
377     # symbols that were not matched by any of the more specific rules
378     # above.  (Assuming that BranchIfCommitsRule() was included above,
379     # then the symbols that are still indeterminate at this point can
380     # sensibly be converted as branches or tags.)  Include at most one
381     # of these lines.  If none of these catch-all rules are included,
382     # then the presence of any ambiguous symbols (that haven't been
383     # disambiguated above) is an error:
385     # Convert ambiguous symbols based on whether they were used more
386     # often as branches or as tags:
387     HeuristicStrategyRule(),
388     # Convert all ambiguous symbols as branches:
389     #AllBranchRule(),
390     # Convert all ambiguous symbols as tags:
391     #AllTagRule(),
393     # The last rule is here to choose the preferred parent of branches
394     # and tags, that is, the line of development from which the symbol
395     # sprouts.
396     HeuristicPreferredParentRule(),
397     ]
399 # Specify a username to be used for commits generated by cvs2svn.  If
400 # this option is set to None then no username will be used for such
401 # commits:
402 ctx.username = None
403 #ctx.username = 'cvs2svn'
405 # ctx.svn_property_setters contains a list of rules used to set the
406 # svn properties on files in the converted archive.  For each file,
407 # the rules are tried one by one.  Any rule can add or suppress one or
408 # more svn properties.  Typically the rules will not overwrite
409 # properties set by a previous rule (though they are free to do so).
410 ctx.svn_property_setters.extend([
411     # To read auto-props rules from a file, uncomment the following line
412     # and specify a filename.  The boolean argument specifies whether
413     # case should be ignored when matching filenames to the filename
414     # patterns found in the auto-props file:
415     #AutoPropsPropertySetter(
416     #    r'/home/username/.subversion/config',
417     #    ignore_case=True,
418     #    ),
420     # To read mime types from a file, uncomment the following line and
421     # specify a filename:
422     #MimeMapper(r'/etc/mime.types'),
424     # Omit the svn:eol-style property from any files that are listed
425     # as binary (i.e., mode '-kb') in CVS:
426     CVSBinaryFileEOLStyleSetter(),
428     # If the file is binary and its svn:mime-type property is not yet
429     # set, set svn:mime-type to 'application/octet-stream'.
430     CVSBinaryFileDefaultMimeTypeSetter(),
432     # To try to determine the eol-style from the mime type, uncomment
433     # the following line:
434     #EOLStyleFromMimeTypeSetter(),
436     # Choose one of the following lines to set the default
437     # svn:eol-style if none of the above rules applied.  The argument
438     # is the svn:eol-style that should be applied, or None if no
439     # svn:eol-style should be set (i.e., the file should be treated as
440     # binary).
441     #
442     # The default is to treat all files as binary unless one of the
443     # previous rules has determined otherwise, because this is the
444     # safest approach.  However, if you have been diligent about
445     # marking binary files with -kb in CVS and/or you have used the
446     # above rules to definitely mark binary files as binary, then you
447     # might prefer to use 'native' as the default, as it is usually
448     # the most convenient setting for text files.  Other possible
449     # options: 'CRLF', 'CR', 'LF'.
450     DefaultEOLStyleSetter(None),
451     #DefaultEOLStyleSetter('native'),
453     # Prevent svn:keywords from being set on files that have
454     # svn:eol-style unset.
455     SVNBinaryFileKeywordsPropertySetter(),
457     # If svn:keywords has not been set yet, set it based on the file's
458     # CVS mode:
459     KeywordsPropertySetter(config.SVN_KEYWORDS_VALUE),
461     # Set the svn:executable flag on any files that are marked in CVS as
462     # being executable:
463     ExecutablePropertySetter(),
465     # Uncomment the following line to include the original CVS revision
466     # numbers as file properties in the SVN archive:
467     #CVSRevisionNumberSetter(),
469     ])
471 # The directory to use for temporary files:
472 ctx.tmpdir = r'cvs2svn-tmp'
474 # To skip the cleanup of temporary files, uncomment the following
475 # option:
476 #ctx.skip_cleanup = True
479 # In CVS, it is perfectly possible to make a single commit that
480 # affects more than one project or more than one branch of a single
481 # project.  Subversion also allows such commits.  Therefore, by
482 # default, when cvs2svn sees what looks like a cross-project or
483 # cross-branch CVS commit, it converts it into a
484 # cross-project/cross-branch Subversion commit.
486 # However, other tools and SCMs have trouble representing
487 # cross-project or cross-branch commits.  (For example, Trac's Revtree
488 # plugin, http://www.trac-hacks.org/wiki/RevtreePlugin is confused by
489 # such commits.)  Therefore, we provide the following two options to
490 # allow cross-project/cross-branch commits to be suppressed.
492 # To prevent CVS commits from different projects from being merged
493 # into single SVN commits, change this option to False:
494 ctx.cross_project_commits = True
496 # To prevent CVS commits on different branches from being merged into
497 # single SVN commits, change this option to False:
498 ctx.cross_branch_commits = True
500 # By default, .cvsignore files are rendered in the output by setting
501 # corresponding svn:ignore properties on the parent directory, but the
502 # .cvsignore files themselves are not included in the conversion
503 # output.  If you would like to include the .cvsignore files in the
504 # output, change this option to True:
505 ctx.keep_cvsignore = False
507 # By default, it is a fatal error for a CVS ",v" file to appear both
508 # inside and outside of an "Attic" subdirectory (this should never
509 # happen, but frequently occurs due to botched repository
510 # administration).  If you would like to retain both versions of such
511 # files, change the following option to True, and the attic version of
512 # the file will be left in an SVN subdirectory called "Attic":
513 ctx.retain_conflicting_attic_files = False
515 # Now use stanzas like the following to define CVS projects that
516 # should be converted.  The arguments are:
518 # - The filesystem path of the project within the CVS repository.
520 # - The path that should be used for the "trunk" directory of this
521 #   project within the SVN repository.  This is an SVN path, so it
522 #   should always use forward slashes ("/").
524 # - The path that should be used for the "branches" directory of this
525 #   project within the SVN repository.  This is an SVN path, so it
526 #   should always use forward slashes ("/").
528 # - The path that should be used for the "tags" directory of this
529 #   project within the SVN repository.  This is an SVN path, so it
530 #   should always use forward slashes ("/").
532 # - A list of symbol transformations that can be used to rename
533 #   symbols in this project.  Each entry is a tuple (pattern,
534 #   replacement), where pattern is a Python regular expression pattern
535 #   and replacement is the text that should replace the pattern.  Each
536 #   pattern is matched against each symbol name.  If the pattern
537 #   matches, then it is replaced with the corresponding replacement
538 #   text.  The replacement can include substitution patterns (e.g.,
539 #   r'\1' or r'\g<name>').  Typically you will want to use raw strings
540 #   (strings with a preceding 'r', like shown in the examples) for the
541 #   regexp and its replacement to avoid backslash substitution within
542 #   those strings.
545 # Create the default project (using ctx.trunk, ctx.branches, and ctx.tags):
546 run_options.add_project(
547     r'test-data/main-cvsrepos',
548     trunk_path='trunk',
549     branches_path='branches',
550     tags_path='tags',
551     initial_directories=[
552         # The project's trunk_path, branches_path, and tags_path
553         # directories are added to the SVN repository in the project's
554         # first commit.  If you would like additional SVN directories
555         # to be created in the project's first commit, list them here:
556         #'releases',
557         ],
558     symbol_transforms=[
559         # Use IgnoreSymbolTransforms like the following to completely
560         # ignore symbols matching a regular expression when parsing
561         # the CVS repository, for example to avoid warnings about
562         # branches with two names and to choose the preferred name.
563         # It is *not* recommended to use this instead of
564         # ExcludeRegexpStrategyRule; though more efficient,
565         # IgnoreSymbolTransforms are less flexible and don't exclude
566         # branches correctly.  The argument is a Python-style regular
567         # expression that has to match the *whole* CVS symbol name:
568         #IgnoreSymbolTransform(r'nightly-build-tag-.*')
570         # RegexpSymbolTransforms transform symbols textually using a
571         # regular expression.  The first argument is a Python regular
572         # expression pattern and the second is a replacement pattern.
573         # The pattern is matched against each symbol name.  If it
574         # matches the whole symbol name, then the symbol name is
575         # replaced with the corresponding replacement text.  The
576         # replacement can include substitution patterns (e.g., r'\1'
577         # or r'\g<name>').  Typically you will want to use raw strings
578         # (strings with a preceding 'r', like shown in the examples)
579         # for the regexp and its replacement to avoid backslash
580         # substitution within those strings.
581         #RegexpSymbolTransform(r'release-(\d+)_(\d+)',
582         #                      r'release-\1.\2'),
583         #RegexpSymbolTransform(r'release-(\d+)_(\d+)_(\d+)',
584         #                      r'release-\1.\2.\3'),
586         # Simple 1:1 character replacements can also be done.  The
587         # following transform, which converts backslashes into forward
588         # slashes, should usually be included:
589         ReplaceSubstringsSymbolTransform('\\','/'),
591         # Eliminate leading, trailing, and repeated slashes.  This
592         # transform should always be included:
593         NormalizePathsSymbolTransform(),
594         ],
595     symbol_strategy_rules=[
596         # Additional, project-specific symbol strategy rules can
597         # be added here.
598         ] + global_symbol_strategy_rules,
599     )
601 # Add a second project, to be stored to projA/trunk, projA/branches,
602 # and projA/tags:
603 #run_options.add_project(
604 #    r'my/cvsrepo/projA',
605 #    trunk_path='projA/trunk',
606 #    branches_path='projA/branches',
607 #    tags_path='projA/tags',
608 #    initial_directories=[
609 #        ],
610 #    symbol_transforms=[
611 #        #RegexpSymbolTransform(r'release-(\d+)_(\d+)',
612 #        #                      r'release-\1.\2'),
613 #        #RegexpSymbolTransform(r'release-(\d+)_(\d+)_(\d+)',
614 #        #                      r'release-\1.\2.\3'),
615 #        ReplaceSubstringsSymbolTransform('\\','/'),
616 #        NormalizePathsSymbolTransform(),
617 #        ],
618 #    symbol_strategy_rules=[
619 #        # Additional, project-specific symbol strategy rules can
620 #        # be added here.
621 #        ] + global_symbol_strategy_rules,
622 #    )
624 # Change this option to True to turn on profiling of cvs2svn (for
625 # debugging purposes):
626 run_options.profiling = False
629 # Should CVSItem -> Changeset database files be memory mapped?  In
630 # some tests, using memory mapping speeded up the overall conversion
631 # by about 5%.  But this option can cause the conversion to fail with
632 # an out of memory error if the conversion computer runs out of
633 # virtual address space (e.g., when running a very large conversion on
634 # a 32-bit operating system).  Therefore it is disabled by default.
635 # Uncomment the following line to allow these database files to be
636 # memory mapped.
637 #changeset_database.use_mmap_for_cvs_item_to_changeset_table = True