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