Skip to content

Latest commit

 

History

History
139 lines (97 loc) · 3.14 KB

conv-params.md

File metadata and controls

139 lines (97 loc) · 3.14 KB

Conversion Parameters

  • branches and tags (default: empty array)

    Arrays that specify which directories should be considered branches and tags. * can be used as a wildcard to specify directories where each subdirectory is a branch or tag.

    Example

    branches = [
      # Consider "trunk" a branch.
      "trunk",
      # Consider each subdirectory in "branches" a branch.
      "branches/*",
      # Do not consider "branches/more" a branch. Instead, consider each
      # subdirectory a branch.
      "branches/more/*",
    ]
    
    tags = [
      # Consider each subdirectory in "tags" a tag.
      "tags/*",
    ]
  • rename-branches and rename-tags (default: empty table)

    By default, branches and tags will have the SVN path as the name. These options allow specifying key-value maps to rename branches and tags.

    There can be exact renames and prefix replacement renames.

    Example

    # Rename "trunk" to "master" (exact rename).
    rename-branches.trunk = "master"
    # Rename "branches/<name>" to "b-<name>" (prefix replacement).
    rename-branches."branches/*" = "b-*"
    
    # Rename "tags/<name>" to "<name>" (prefix replacement).
    rename-tags."tags/*" = "*"
  • keep-deleted-branches and keep-deleted-tags (default: true)

    Specifies whether the Git repository should keep branches or tags that have been removed from the Subversion repository.

    Example

    keep-deleted-branches = false
    keep-deleted-tags = false
  • head (default: trunk)

    Specifies which branch will be used as Git HEAD. You have to specify the Subversion path of the branch (even if you renamed it with rename-branches).

    Example

    # The branch whose SVN path is "trunk" will be used as Git HEAD.
    head = "trunk"

    You can set it to an empty string to use the unbranched branch (see below) as HEAD.

    Example

    head = ""
  • unbranched-name (default: unbranched)

    Specifies the name of the Git branch where everything that is not part of a branch or a tag (as specified with branches or tags) will be placed.

    Example

    unbranched-name = "unbranched"
  • enable-merges (default: true)

    Whether to enable or not the generation of Git merges based on Subversion mergeinfo.

    Example

    # Disable Git merges
    enable-merges = "false"
  • generate-gitignore (default: true)

    Whether to generate .gitignore files from svn:ignore and svn:global-ignores properties. Existing .gitignore files in the Subversion repository will be removed or replaced.

    Example

    # Generate .gitignore files
    generate-gitignore = "true"
  • delete-files (default: empty array)

    Array of patterns that match paths of files that should be deleted.

    Example

    delete-files = [
      # Delete ".cvsignore" files (regardless of their location)
      "**/.cvsignore",
    ]
  • user-map-file

    Specifies the path (relative to the location of the parameters TOML file) which maps Subversion usernames to Git names/emails.

    Example

    user-map-file = "user-map.txt"