a path to the directory where SubGit logs are being stored. The path can be either absolute or relative to the Git repository where import/mirror from SVN is being performed to.
logs = PATH
SubGit logs verbosity level. There are three levels:
logLevel = [info|finer|finest]
INFO– default level, least verbose, reflects import/mirror process steps.
FINER– more verbose, Subgit logs every action it performs.
FINEST– most verbose, logs everything, including whole network traffic with all the payload.
The values are case-insensitive. Default log level is
a boolean value, can be set to
shared = [true|false]
true, all files in the Git repository will be made group-writable;
falsewill set all the files owner writable only. The option must be
truewhen more than one system account is used to work with this repository. The default is
a path to the authors mapping file or authors mapping helper program:
authorsFile = PATH
authors mapping file – a text file with explicit authors mapping:
- authors helper program – an executable authors mapping helper program and its optional arguments.
Find more details on authors mapping in the authors mapping user manual.
There could be more than one
authorsFileoptions specified, they will be processed from the last to the first until the mapping is obtained.
encoding in which authors mapping information is present. The default value is
authorsFileEncoding = ENCODING
defaultDomain = DOMAINdomain to be used to generate Git committer email when authors mapping is not defined or does not provide an email address for a particular committer.
a way SubGit handles translation failures. There are three possible options:
failSafe = [auto|svn|git]
auto– failed translation results in commits or pushes to be blocked on the side to which translation has failed.
svn– commits to Subversion are never being blocked.
git– pushes to Git are never being blocked.
pathEncoding = ENCODINGencoding to be used to store paths in Git tree objects. The default value is
gitPath = PATHa path to Git executable. If this option is set, Git executable will be used to stream large files and perform Git garbage collection that can significantly decrease memory and disk space consumption.
streamFileThreshold = SIZEfile size in bytes. SubGit loads the entire file into memory if its size less than this threshold; if the file is larger than the threshold, SubGit sends it as a stream. The option is not set by default, but SubGit sets the threshold to 50MB when the option is not set, so default threshold is 50MB. Note, the bigger the threshold is, the more likely to run into OutOfMemory error.
a path to Java home directory; this Java RE will be used to run hooks.
javaHome = PATH
SVN project URL to be used for import/mirror. Supported protocols:
url = URL
trunk = PATHa path to SVN project
trunkrelative to the SVN project URL. For more details see "Branches and Tags mapping" user manual.
branches = PATHa path to SVN project
branchesdirectory relative to the SVN project URL. There can be more than one
branchesoption in a configuration. For more details see "Branches and Tags mapping" user manual.
tags = PATHa path to SVN project
tagsdirectory relative to the SVN project URL. There can be more than one
tagsoption in a configuration. For more details see "Branches and Tags mapping" user manual.
shelves = PATHa path to SVN project
shelvesdirectory relative to the SVN project URL; this is special directory intended to store commits in some ambiguous situations when SubGit is unable to determine branch name where those particular commits belong to, find more details in the "What are shelves really?" blog post.
excludeBranches = SIMPLE_PATTERNa string that represents a branch or tag name to be excluded from translation. It can be either full branch or tag name or a name pattern with one wildcard. Interchangeable with
excludeTags. For more details see "Branches and Tags mapping" user manual.
excludeTags = SIMPLE_PATTERNa string that represents a branch or tag name to be excluded from translation. It can be either full branch or tag name or a name pattern with one wildcard. Interchangeable with
excludeBranches. For more details see "Branches and Tags mapping" user manual.
includePath = PATTERNa string pattern that represents files or directories to be included in translation. There are few rules that apply to the pattern, find the details in "Branches and Tags mapping" user manual.
excludePath = PATTERNopposite for
includePath, a string pattern that represents files or directories to be excluded from translation. There are few rules that apply to the pattern, find the details in "Branches and Tags mapping" user manual.
auth = [default,option1,…]comma-separated list of
[auth]sections IDs where Subversion credentials are defined. Credentials will be used both for read-only and write operations, and it is recommended to define credentials of an account that has full access to the Subversion repository. There is one
defaultsection from scratch.
minimalRevision = REVISIONminimal SVN repository revision number the import/mirror should start from.
fetchInterval = INTERVALtime interval in seconds. SubGit will fetch changes from SVN every
INTERVAL. The default value is 60.
connectTimeout = TIMEOUTSVN connection timeout in seconds. The default value is 300 seconds.
readTimeout = TIMEOUTSVN connection read timeout in seconds. The default value is 600 seconds.
httpSpooling = [true|false]enable HTTP requests spooling to prevent server-side timeout when request processing takes a long time. The default value is
triggerSvnPostReceive = [true|false]If
true, SubGit invokes user-post-receive hook during changes translation from SVN side to Git repository, otherwise it doesn't. This option exerts influence on SVN-to-Git translation only, when SubGit translates changes from Git to SVN it invokes hooks irrespective of this option.
triggerGitGC = [true|false|N]If the settings is set to
true, SubGit will always run Git garbage collection
falseit won't run the collection. A numeric value
Nrepresents a number of revisions; SubGit will invoke
keepGitCommitTime = [true|false]When
true,SVN commits will have the same dates as corresponding Git commits, even if this violates monotonic increase of commit dates from revision to revision. When
false, SubGit will try to preserve Git commit dates while translation to SVN, but it will guarantee SVN dates to increase monotonically from revision to revision. The default value is
a pattern that represents revision properties to be set when a Git commit is translated to SVN, comma or space separated. Supported values are:
revisionProperties = PATTERN
subgit:authoras the author of Git commit.
subgit:committeras the committer of Git commit
subgit:dateGit commit creation date in a form "YY-MM-DD hh:mm:ss Z".
subgit:logas the Git commit message.
subgit:commitas the Git commit SHA-1 hash.
subgit:svnUseras the SVN user SubGit uses to create a revision.
There are two ways to set the PATTERN:
the first is just list the values:
In this case, SubGit will set SVN the following revision properties:
Another way is to set values along with some custom namespace, e.g. for custom namespace git:
In such case SubGit will set the SVN revision properties using that exact git namespace:
a pattern consisting of placeholders that construct SVN commit message when a Git commit is being translated to SVN. There are several acceptable placeholders:
svnCommitMessage = PATTERN
%author= Git author
%committer= Git committer
%date= Git commit date
%message= original message
%note= Git commit note stored under refs/notes/commits
%note(refs/notes/namespace)= Git commit note stored under refs/notes/namespace
%commit= Git commit hash
%svnUser= Subversion username
%branch= Subversion branch
\n= newline feed
For example, if the
svnCommitMessagewas set like this:
and then a commit has been pushed to the mirrored Git repository:
respective SVN revision will look like this:
gitCommitMessage = PATTERN
allowBranchReplacement = [true|false]
allowReplacementBranches = PATH
allowBranchDeletion = [true|false]
allowDeletionBranches = PATH
allowForcePush = [true|false]
cleanStaleRefLocks = [true|false]