Decode .cvsignore contents and re-encode them as UTF-8.
[cvs2svn.git] / cvs2git-example.options
blob44646f6820908d05634d19d9ea8648f2433d2cc2
1 # (Be in -*- mode: python; coding: utf-8 -*- mode.)
3 # ====================================================================
4 # Copyright (c) 2006-2010 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
29 # like this:
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 #       cvs_executable = 'c:\\windows\\system32\\cvs.exe'
58 #       cvs_executable = r'c:\windows\system32\cvs.exe'
60 #   See http://docs.python.org/tutorial/introduction.html#strings for
61 #   more information.
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:
75 import os
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 logger
81 from cvs2svn_lib.git_revision_collector import GitRevisionCollector
82 from cvs2svn_lib.external_blob_generator import ExternalBlobGenerator
83 from cvs2svn_lib.git_output_option import GitRevisionMarkWriter
84 from cvs2svn_lib.git_output_option import GitOutputOption
85 from cvs2svn_lib.dvcs_common import KeywordHandlingPropertySetter
86 from cvs2svn_lib.rcs_revision_manager import RCSRevisionReader
87 from cvs2svn_lib.cvs_revision_manager import CVSRevisionReader
88 from cvs2svn_lib.symbol_strategy import AllBranchRule
89 from cvs2svn_lib.symbol_strategy import AllTagRule
90 from cvs2svn_lib.symbol_strategy import BranchIfCommitsRule
91 from cvs2svn_lib.symbol_strategy import ExcludeRegexpStrategyRule
92 from cvs2svn_lib.symbol_strategy import ForceBranchRegexpStrategyRule
93 from cvs2svn_lib.symbol_strategy import ForceTagRegexpStrategyRule
94 from cvs2svn_lib.symbol_strategy import ExcludeTrivialImportBranchRule
95 from cvs2svn_lib.symbol_strategy import ExcludeVendorBranchRule
96 from cvs2svn_lib.symbol_strategy import HeuristicStrategyRule
97 from cvs2svn_lib.symbol_strategy import UnambiguousUsageRule
98 from cvs2svn_lib.symbol_strategy import HeuristicPreferredParentRule
99 from cvs2svn_lib.symbol_strategy import SymbolHintsFileRule
100 from cvs2svn_lib.symbol_transform import ReplaceSubstringsSymbolTransform
101 from cvs2svn_lib.symbol_transform import RegexpSymbolTransform
102 from cvs2svn_lib.symbol_transform import IgnoreSymbolTransform
103 from cvs2svn_lib.symbol_transform import NormalizePathsSymbolTransform
104 from cvs2svn_lib.property_setters import AutoPropsPropertySetter
105 from cvs2svn_lib.property_setters import ConditionalPropertySetter
106 from cvs2svn_lib.property_setters import cvs_file_is_binary
107 from cvs2svn_lib.property_setters import CVSBinaryFileDefaultMimeTypeSetter
108 from cvs2svn_lib.property_setters import CVSBinaryFileEOLStyleSetter
109 from cvs2svn_lib.property_setters import DefaultEOLStyleSetter
110 from cvs2svn_lib.property_setters import EOLStyleFromMimeTypeSetter
111 from cvs2svn_lib.property_setters import ExecutablePropertySetter
112 from cvs2svn_lib.property_setters import KeywordsPropertySetter
113 from cvs2svn_lib.property_setters import MimeMapper
114 from cvs2svn_lib.property_setters import SVNBinaryFileKeywordsPropertySetter
116 # To choose the level of logging output, uncomment one of the
117 # following lines:
118 #logger.log_level = logger.WARN
119 #logger.log_level = logger.QUIET
120 logger.log_level = logger.NORMAL
121 #logger.log_level = logger.VERBOSE
122 #logger.log_level = logger.DEBUG
125 # The directory to use for temporary files:
126 ctx.tmpdir = r'cvs2svn-tmp'
128 # During FilterSymbolsPass, cvs2git records the contents of file
129 # revisions into a "blob" file in git-fast-import format.  The
130 # ctx.revision_collector option configures that process.  Choose one of the two ersions and customize its options.
132 # This first alternative is much slower but is better tested and has a
133 # chance of working with CVSNT repositories.  It invokes CVS or RCS to
134 # reconstuct the contents of CVS file revisions:
135 ctx.revision_collector = GitRevisionCollector(
136     # The file in which to write the git-fast-import stream that
137     # contains the file revision contents:
138     'cvs2svn-tmp/git-blob.dat',
140     # The following option specifies how the revision contents of the
141     # RCS files should be read.
142     #
143     # RCSRevisionReader uses RCS's "co" program to extract the
144     # revision contents of the RCS files during CollectRevsPass.  The
145     # constructor argument specifies how to invoke the "co"
146     # executable.
147     #
148     # CVSRevisionReader uses the "cvs" program to extract the revision
149     # contents out of the RCS files during OutputPass.  This option is
150     # considerably slower than RCSRevisionReader because "cvs" is
151     # considerably slower than "co".  However, it works in some
152     # situations where RCSRevisionReader fails; see the HTML
153     # documentation of the "--use-cvs" option for details.  The
154     # constructor argument specifies how to invoke the "co"
155     # executable.  It is also possible to pass a global_options
156     # parameter to CVSRevisionReader to specify which options should
157     # be passed to the cvs command.  By default the correct options
158     # are usually chosen, but for CVSNT you might want to add
159     # global_options=['-q', '-N', '-f'].
160     #
161     # Uncomment one of the two following lines:
162     #RCSRevisionReader(co_executable=r'co'),
163     CVSRevisionReader(cvs_executable=r'cvs'),
164     )
165 # This second alternative is vastly faster than the version above.  It
166 # uses an external Python program to reconstruct the contents of CVS
167 # file revisions:
168 #ctx.revision_collector = ExternalBlobGenerator('cvs2svn-tmp/git-blob.dat')
170 # cvs2git doesn't need a revision reader because OutputPass only
171 # refers to blobs that were output during CollectRevsPass, so leave
172 # this option set to None.
173 ctx.revision_reader = None
175 # Change the following line to True if the conversion should only
176 # include the trunk of the repository (i.e., all branches and tags
177 # should be omitted from the conversion):
178 ctx.trunk_only = False
180 # How to convert CVS author names, log messages, and filenames to
181 # Unicode.  The first argument to CVSTextDecoder is a list of encoders
182 # that are tried in order in 'strict' mode until one of them succeeds.
183 # If none of those succeeds, then fallback_encoder (if it is
184 # specified) is used in lossy 'replace' mode.  Setting a fallback
185 # encoder ensures that the encoder always succeeds, but it can cause
186 # information loss.
187 ctx.cvs_author_decoder = CVSTextDecoder(
188     [
189         #'utf8',
190         #'latin1',
191         'ascii',
192         ],
193     #fallback_encoding='ascii'
194     )
195 ctx.cvs_log_decoder = CVSTextDecoder(
196     [
197         #'utf8',
198         #'latin1',
199         'ascii',
200         ],
201     #fallback_encoding='ascii',
202     eol_fix='\n',
203     )
204 # You might want to be especially strict when converting filenames to
205 # Unicode (e.g., maybe not specify a fallback_encoding).
206 ctx.cvs_filename_decoder = CVSTextDecoder(
207     [
208         #'utf8',
209         #'latin1',
210         'ascii',
211         ],
212     #fallback_encoding='ascii'
213     )
215 # Template for the commit message to be used for initial project
216 # commits.
217 ctx.initial_project_commit_message = (
218     'Standard project directories initialized by cvs2svn.'
219     )
221 # Template for the commit message to be used for post commits, in
222 # which modifications to a vendor branch are copied back to trunk.
223 # This message can use '%(revnum)d' to include the SVN revision number
224 # of the revision that included the change to the vendor branch
225 # (admittedly rather pointless in a cvs2git conversion).
226 ctx.post_commit_message = (
227     'This commit was generated by cvs2svn to track changes on a CVS '
228     'vendor branch.'
229     )
231 # Template for the commit message to be used for commits in which
232 # symbols are created.  This message can use '%(symbol_type)s' to
233 # include the type of the symbol ('branch' or 'tag') or
234 # '%(symbol_name)s' to include the name of the symbol.
235 ctx.symbol_commit_message = (
236     "This commit was manufactured by cvs2svn to create %(symbol_type)s "
237     "'%(symbol_name)s'."
238     )
240 # Template for the commit message to be used for commits in which
241 # tags are pseudo-merged back to their source branch.  This message can
242 # use '%(symbol_name)s' to include the name of the symbol.
243 # (Not used by default unless you enable tie_tag_fixup_branches on
244 # GitOutputOption.)
245 ctx.tie_tag_ancestry_message = (
246     "This commit was manufactured by cvs2svn to tie ancestry for "
247     "tag '%(symbol_name)s' back to the source branch."
248     )
250 # Some CVS clients for MacOS store resource fork data into CVS along
251 # with the file contents itself by wrapping it all up in a container
252 # format called "AppleSingle".  Subversion currently does not support
253 # MacOS resource forks.  Nevertheless, sometimes the resource fork
254 # information is not necessary and can be discarded.  Set the
255 # following option to True if you would like cvs2svn to identify files
256 # whose contents are encoded in AppleSingle format, and discard all
257 # but the data fork for such files before committing them to
258 # Subversion.  (Please note that AppleSingle contents are identified
259 # by the AppleSingle magic number as the first four bytes of the file.
260 # This check is not failproof, so only set this option if you think
261 # you need it.)
262 ctx.decode_apple_single = False
264 # This option can be set to the name of a filename to which are stored
265 # statistics and conversion decisions about the CVS symbols.
266 ctx.symbol_info_filename = None
267 #ctx.symbol_info_filename = 'symbol-info.txt'
269 # cvs2svn uses "symbol strategy rules" to help decide how to handle
270 # CVS symbols.  The rules in a project's symbol_strategy_rules are
271 # applied in order, and each rule is allowed to modify the symbol.
272 # The result (after each of the rules has been applied) is used for
273 # the conversion.
275 # 1. A CVS symbol might be used as a tag in one file and as a branch
276 #    in another file.  cvs2svn has to decide whether to convert such a
277 #    symbol as a tag or as a branch.  cvs2svn uses a series of
278 #    heuristic rules to decide how to convert a symbol.  The user can
279 #    override the default rules for specific symbols or symbols
280 #    matching regular expressions.
282 # 2. cvs2svn is also capable of excluding symbols from the conversion
283 #    (provided no other symbols depend on them.
285 # 3. CVS does not record unambiguously the line of development from
286 #    which a symbol sprouted.  cvs2svn uses a heuristic to choose a
287 #    symbol's "preferred parents".
289 # The standard branch/tag/exclude StrategyRules do not change a symbol
290 # that has already been processed by an earlier rule, so in effect the
291 # first matching rule is the one that is used.
293 global_symbol_strategy_rules = [
294     # It is possible to specify manually exactly how symbols should be
295     # converted and what line of development should be used as the
296     # preferred parent.  To do so, create a file containing the symbol
297     # hints and enable the following option.
298     #
299     # The format of the hints file is described in the documentation
300     # for the --symbol-hints command-line option.  The file output by
301     # the --write-symbol-info (i.e., ctx.symbol_info_filename) option
302     # is in the same format.  The simplest way to use this option is
303     # to run the conversion through CollateSymbolsPass with
304     # --write-symbol-info option, copy the symbol info and edit it to
305     # create a hints file, then re-start the conversion at
306     # CollateSymbolsPass with this option enabled.
307     #SymbolHintsFileRule('symbol-hints.txt'),
309     # To force all symbols matching a regular expression to be
310     # converted as branches, add rules like the following:
311     #ForceBranchRegexpStrategyRule(r'branch.*'),
313     # To force all symbols matching a regular expression to be
314     # converted as tags, add rules like the following:
315     #ForceTagRegexpStrategyRule(r'tag.*'),
317     # To force all symbols matching a regular expression to be
318     # excluded from the conversion, add rules like the following:
319     #ExcludeRegexpStrategyRule(r'unknown-.*'),
321     # Sometimes people use "cvs import" to get their own source code
322     # into CVS.  This practice creates a vendor branch 1.1.1 and
323     # imports the code onto the vendor branch as 1.1.1.1, then copies
324     # the same content to the trunk as version 1.1.  Normally, such
325     # vendor branches are useless and they complicate the SVN history
326     # unnecessarily.  The following rule excludes any branches that
327     # only existed as a vendor branch with a single import (leaving
328     # only the 1.1 revision).  If you want to retain such branches,
329     # comment out the following line.  (Please note that this rule
330     # does not exclude vendor *tags*, as they are not so easy to
331     # identify.)
332     ExcludeTrivialImportBranchRule(),
334     # To exclude all vendor branches (branches that had "cvs import"s
335     # on them but no other kinds of commits), uncomment the following
336     # line:
337     #ExcludeVendorBranchRule(),
339     # Usually you want this rule, to convert unambiguous symbols
340     # (symbols that were only ever used as tags or only ever used as
341     # branches in CVS) the same way they were used in CVS:
342     UnambiguousUsageRule(),
344     # If there was ever a commit on a symbol, then it cannot be
345     # converted as a tag.  This rule causes all such symbols to be
346     # converted as branches.  If you would like to resolve such
347     # ambiguities manually, comment out the following line:
348     BranchIfCommitsRule(),
350     # Last in the list can be a catch-all rule that is used for
351     # symbols that were not matched by any of the more specific rules
352     # above.  (Assuming that BranchIfCommitsRule() was included above,
353     # then the symbols that are still indeterminate at this point can
354     # sensibly be converted as branches or tags.)  Include at most one
355     # of these lines.  If none of these catch-all rules are included,
356     # then the presence of any ambiguous symbols (that haven't been
357     # disambiguated above) is an error:
359     # Convert ambiguous symbols based on whether they were used more
360     # often as branches or as tags:
361     HeuristicStrategyRule(),
362     # Convert all ambiguous symbols as branches:
363     #AllBranchRule(),
364     # Convert all ambiguous symbols as tags:
365     #AllTagRule(),
367     # The last rule is here to choose the preferred parent of branches
368     # and tags, that is, the line of development from which the symbol
369     # sprouts.
370     HeuristicPreferredParentRule(),
371     ]
373 # Specify a username to be used for commits for which CVS doesn't
374 # record the original author (for example, the creation of a branch).
375 # This should be a simple (unix-style) username, but it can be
376 # translated into a git-style name by the author_transforms map.
377 ctx.username = 'cvs2svn'
379 # ctx.file_property_setters and ctx.revision_property_setters contain
380 # rules used to set the svn properties on files in the converted
381 # archive.  For each file, the rules are tried one by one.  Any rule
382 # can add or suppress one or more svn properties.  Typically the rules
383 # will not overwrite properties set by a previous rule (though they
384 # are free to do so).  ctx.file_property_setters should be used for
385 # properties that remain the same for the life of the file; these
386 # should implement FilePropertySetter.  ctx.revision_property_setters
387 # should be used for properties that are allowed to vary from revision
388 # to revision; these should implement RevisionPropertySetter.
390 # Obviously, SVN properties per se are not interesting for a cvs2git
391 # conversion, but some of these properties have side-effects that do
392 # affect the git output.  FIXME: Document this in more detail.
393 ctx.file_property_setters.extend([
394     # To read auto-props rules from a file, uncomment the following line
395     # and specify a filename.  The boolean argument specifies whether
396     # case should be ignored when matching filenames to the filename
397     # patterns found in the auto-props file:
398     #AutoPropsPropertySetter(
399     #    r'/home/username/.subversion/config',
400     #    ignore_case=True,
401     #    ),
403     # To read mime types from a file and use them to set svn:mime-type
404     # based on the filename extensions, uncomment the following line
405     # and specify a filename (see
406     # http://en.wikipedia.org/wiki/Mime.types for information about
407     # mime.types files):
408     #MimeMapper(r'/etc/mime.types', ignore_case=False),
410     # Omit the svn:eol-style property from any files that are listed
411     # as binary (i.e., mode '-kb') in CVS:
412     CVSBinaryFileEOLStyleSetter(),
414     # If the file is binary and its svn:mime-type property is not yet
415     # set, set svn:mime-type to 'application/octet-stream'.
416     CVSBinaryFileDefaultMimeTypeSetter(),
418     # To try to determine the eol-style from the mime type, uncomment
419     # the following line:
420     #EOLStyleFromMimeTypeSetter(),
422     # Choose one of the following lines to set the default
423     # svn:eol-style if none of the above rules applied.  The argument
424     # is the svn:eol-style that should be applied, or None if no
425     # svn:eol-style should be set (i.e., the file should be treated as
426     # binary).
427     #
428     # The default is to treat all files as binary unless one of the
429     # previous rules has determined otherwise, because this is the
430     # safest approach.  However, if you have been diligent about
431     # marking binary files with -kb in CVS and/or you have used the
432     # above rules to definitely mark binary files as binary, then you
433     # might prefer to use 'native' as the default, as it is usually
434     # the most convenient setting for text files.  Other possible
435     # options: 'CRLF', 'CR', 'LF'.
436     DefaultEOLStyleSetter(None),
437     #DefaultEOLStyleSetter('native'),
439     # Prevent svn:keywords from being set on files that have
440     # svn:eol-style unset.
441     SVNBinaryFileKeywordsPropertySetter(),
443     # If svn:keywords has not been set yet, set it based on the file's
444     # CVS mode:
445     KeywordsPropertySetter(config.SVN_KEYWORDS_VALUE),
447     # Set the svn:executable flag on any files that are marked in CVS as
448     # being executable:
449     ExecutablePropertySetter(),
451     # The following causes keywords to be untouched in binary files and
452     # collapsed in all text to be committed:
453     ConditionalPropertySetter(
454         cvs_file_is_binary, KeywordHandlingPropertySetter('untouched'),
455         ),
456     KeywordHandlingPropertySetter('collapsed'),
458     ])
459 ctx.revision_property_setters.extend([
460     ])
462 # To skip the cleanup of temporary files, uncomment the following
463 # option:
464 #ctx.skip_cleanup = True
467 # In CVS, it is perfectly possible to make a single commit that
468 # affects more than one project or more than one branch of a single
469 # project.  Subversion also allows such commits.  Therefore, by
470 # default, when cvs2svn sees what looks like a cross-project or
471 # cross-branch CVS commit, it converts it into a
472 # cross-project/cross-branch Subversion commit.
474 # However, other tools and SCMs have trouble representing
475 # cross-project or cross-branch commits.  (For example, Trac's Revtree
476 # plugin, http://www.trac-hacks.org/wiki/RevtreePlugin is confused by
477 # such commits.)  Therefore, we provide the following two options to
478 # allow cross-project/cross-branch commits to be suppressed.
480 # cvs2git only supports single-project conversions (multiple-project
481 # conversions wouldn't really make sense for git anyway).  So this
482 # option must be set to False:
483 ctx.cross_project_commits = False
485 # git itself doesn't allow commits that affect more than one branch,
486 # so this option must be set to False:
487 ctx.cross_branch_commits = False
489 # cvs2git does not yet handle translating .cvsignore files into
490 # .gitignore files, so by default, the .cvsignore files are included
491 # in the conversion output.  If you would like to omit the .cvsignore
492 # files from the output, set this option to False:
493 ctx.keep_cvsignore = True
495 # By default, it is a fatal error for a CVS ",v" file to appear both
496 # inside and outside of an "Attic" subdirectory (this should never
497 # happen, but frequently occurs due to botched repository
498 # administration).  If you would like to retain both versions of such
499 # files, change the following option to True, and the attic version of
500 # the file will be written to a subdirectory called "Attic" in the
501 # output repository:
502 ctx.retain_conflicting_attic_files = False
504 # CVS uses unix login names as author names whereas git requires
505 # author names to be of the form "foo <bar>".  The default is to set
506 # the git author to "cvsauthor <cvsauthor>".  author_transforms can be
507 # used to map cvsauthor names (e.g., "jrandom") to a true name and
508 # email address (e.g., "J. Random <jrandom@example.com>" for the
509 # example shown).  All strings should be either Unicode strings (i.e.,
510 # with "u" as a prefix) or 8-bit strings in the utf-8 encoding.  The
511 # values can either be strings in the form "name <email>" or tuples
512 # (name, email).  Please substitute your own project's usernames here
513 # to use with the author_transforms option of GitOutputOption below.
514 author_transforms={
515     'jrandom' : ('J. Random', 'jrandom@example.com'),
516     'mhagger' : 'Michael Haggerty <mhagger@alum.mit.edu>',
517     'brane' : (u'Branko Čibej', 'brane@xbc.nu'),
518     'ringstrom' : 'Tobias Ringström <tobias@ringstrom.mine.nu>',
519     'dionisos' : (u'Erik Hülsmann', 'e.huelsmann@gmx.net'),
521     # This one will be used for commits for which CVS doesn't record
522     # the original author, as explained above.
523     'cvs2svn' : 'cvs2svn <admin@example.com>',
524     }
526 # This is the main option that causes cvs2svn to output to a
527 # "fastimport"-format dumpfile rather than to Subversion:
528 ctx.output_option = GitOutputOption(
529     # The file in which to write the git-fast-import stream that
530     # contains the changesets and branch/tag information:
531     os.path.join(ctx.tmpdir, 'git-dump.dat'),
533     # The blobs will be written via the revision recorder, so in
534     # OutputPass we only have to emit references to the blob marks:
535     GitRevisionMarkWriter(),
537     # Optional map from CVS author names to git author names:
538     author_transforms=author_transforms,
539     )
541 # Change this option to True to turn on profiling of cvs2svn (for
542 # debugging purposes):
543 run_options.profiling = False
546 # Should CVSItem -> Changeset database files be memory mapped?  In
547 # some tests, using memory mapping speeded up the overall conversion
548 # by about 5%.  But this option can cause the conversion to fail with
549 # an out of memory error if the conversion computer runs out of
550 # virtual address space (e.g., when running a very large conversion on
551 # a 32-bit operating system).  Therefore it is disabled by default.
552 # Uncomment the following line to allow these database files to be
553 # memory mapped.
554 #changeset_database.use_mmap_for_cvs_item_to_changeset_table = True
556 # Now set the project to be converted to git.  cvs2git only supports
557 # single-project conversions, so this method must only be called
558 # once:
559 run_options.set_project(
560     # The filesystem path to the part of the CVS repository (*not* a
561     # CVS working copy) that should be converted.  This may be a
562     # subdirectory (i.e., a module) within a larger CVS repository.
563     r'test-data/main-cvsrepos',
565     # A list of symbol transformations that can be used to rename
566     # symbols in this project.
567     symbol_transforms=[
568         # Use IgnoreSymbolTransforms like the following to completely
569         # ignore symbols matching a regular expression when parsing
570         # the CVS repository, for example to avoid warnings about
571         # branches with two names and to choose the preferred name.
572         # It is *not* recommended to use this instead of
573         # ExcludeRegexpStrategyRule; though more efficient,
574         # IgnoreSymbolTransforms are less flexible and don't exclude
575         # branches correctly.  The argument is a Python-style regular
576         # expression that has to match the *whole* CVS symbol name:
577         #IgnoreSymbolTransform(r'nightly-build-tag-.*')
579         # RegexpSymbolTransforms transform symbols textually using a
580         # regular expression.  The first argument is a Python regular
581         # expression pattern and the second is a replacement pattern.
582         # The pattern is matched against each symbol name.  If it
583         # matches the whole symbol name, then the symbol name is
584         # replaced with the corresponding replacement text.  The
585         # replacement can include substitution patterns (e.g., r'\1'
586         # or r'\g<name>').  Typically you will want to use raw strings
587         # (strings with a preceding 'r', like shown in the examples)
588         # for the regexp and its replacement to avoid backslash
589         # substitution within those strings.
590         #RegexpSymbolTransform(r'release-(\d+)_(\d+)',
591         #                      r'release-\1.\2'),
592         #RegexpSymbolTransform(r'release-(\d+)_(\d+)_(\d+)',
593         #                      r'release-\1.\2.\3'),
595         # Simple 1:1 character replacements can also be done.  The
596         # following transform, which converts backslashes into forward
597         # slashes, should usually be included:
598         ReplaceSubstringsSymbolTransform('\\','/'),
600         # This last rule eliminates leading, trailing, and repeated
601         # slashes within the output symbol names:
602         NormalizePathsSymbolTransform(),
603         ],
605     # See the definition of global_symbol_strategy_rules above for a
606     # description of this option:
607     symbol_strategy_rules=global_symbol_strategy_rules,
609     # Exclude paths from the conversion. Should be relative to
610     # repository path and use forward slashes:
611     #exclude_paths=['file-to-exclude.txt,v', 'dir/to/exclude'],
612     )