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