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