man1/git-cvsimport.1

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "GIT-CVSIMPORT" 1 "" "" ""
  21 .SH NAME
  22 git-cvsimport \- Import a CVS repository into git
  23 .SH "SYNOPSIS"
  24
  25 .nf
  26 git\-cvsimport [\-o <branch\-for\-HEAD>] [\-h] [\-v] [\-d <CVSROOT>] [\-s <subst>]
  27               [\-p <options\-for\-cvsps>] [\-C <git_repository>] [\-i] [\-P <file>]
  28               [\-m] [\-M regex] [<CVS_module>]
  29 .fi
  30
  31 .SH "DESCRIPTION"
  32
  33
  34 Imports a CVS repository into git\&. It will either create a new repository, or incrementally import into an existing one\&.
  35
  36
  37 Splitting the CVS log into patch sets is done by cvsps\&. At least version 2\&.1 is required\&.
  38
  39 .SH "OPTIONS"
  40
  41 .TP
  42 \-d <CVSROOT>
  43 The root of the CVS archive\&. May be local (a simple path) or remote; currently, only the :local:, :ext: and :pserver: access methods are supported\&.
  44
  45 .TP
  46 \-C <target\-dir>
  47 The git repository to import to\&. If the directory doesn't exist, it will be created\&. Default is the current directory\&.
  48
  49 .TP
  50 \-i
  51 Import\-only: don't perform a checkout after importing\&. This option ensures the working directory and index remain untouched and will not create them if they do not exist\&.
  52
  53 .TP
  54 \-k
  55 Kill keywords: will extract files with \-kk from the CVS archive to avoid noisy changesets\&. Highly recommended, but off by default to preserve compatibility with early imported trees\&.
  56
  57 .TP
  58 \-u
  59 Convert underscores in tag and branch names to dots\&.
  60
  61 .TP
  62 \-o <branch\-for\-HEAD>
  63 The HEAD branch from CVS is imported to the origin branch within the git repository, as HEAD already has a special meaning for git\&. Use this option if you want to import into a different branch\&.
  64
  65 Use \-o master for continuing an import that was initially done by the old cvs2git tool\&.
  66
  67 .TP
  68 \-p <options\-for\-cvsps>
  69 Additional options for cvsps\&. The options \-u and \-A are implicit and should not be used here\&.
  70
  71 If you need to pass multiple options, separate them with a comma\&.
  72
  73 .TP
  74 \-P <cvsps\-output\-file>
  75 Instead of calling cvsps, read the provided cvsps output file\&. Useful for debugging or when cvsps is being handled outside cvsimport\&.
  76
  77 .TP
  78 \-m
  79 Attempt to detect merges based on the commit message\&. This option will enable default regexes that try to capture the name source branch name from the commit message\&.
  80
  81 .TP
  82 \-M <regex>
  83 Attempt to detect merges based on the commit message with a custom regex\&. It can be used with \-m to also see the default regexes\&. You must escape forward slashes\&.
  84
  85 .TP
  86 \-v
  87 Verbosity: let cvsimport report what it is doing\&.
  88
  89 .TP
  90 <CVS_module>
  91 The CVS module you want to import\&. Relative to <CVSROOT>\&.
  92
  93 .TP
  94 \-h
  95 Print a short usage message and exit\&.
  96
  97 .TP
  98 \-z <fuzz>
  99 Pass the timestamp fuzz factor to cvsps\&.
 100
 101 .TP
 102 \-s <subst>
 103 Substitute the character "/" in branch names with <subst>
 104
 105 .TP
 106 \-A <author\-conv\-file>
 107 CVS by default uses the unix username when writing its commit logs\&. Using this option and an author\-conv\-file in this format
 108
 109 .nf
 110 exon=Andreas Ericsson <ae@op5\&.se>
 111 spawn=Simon Pawn <spawn@frog\-pond\&.org>
 112 .fi
 113
 114 .nf
 115 git\-cvsimport will make it appear as those authors had
 116 their GIT_AUTHOR_NAME and GIT_AUTHOR_EMAIL set properly
 117 all along\&.
 118 .fi
 119
 120 .nf
 121 For convenience, this data is saved to $GIT_DIR/cvs\-authors
 122 each time the \-A option is provided and read from that same
 123 file each time git\-cvsimport is run\&.
 124 .fi
 125
 126 .nf
 127 It is not recommended to use this feature if you intend to
 128 export changes back to CVS again later with
 129 git\-link[1]::git\-cvsexportcommit\&.
 130 .fi
 131
 132 .SH "OUTPUT"
 133
 134
 135 If \-v is specified, the script reports what it is doing\&.
 136
 137
 138 Otherwise, success is indicated the Unix way, i\&.e\&. by simply exiting with a zero exit status\&.
 139
 140 .SH "AUTHOR"
 141
 142
 143 Written by Matthias Urlichs <smurf@smurf\&.noris\&.de>, with help from various participants of the git\-list <git@vger\&.kernel\&.org>\&.
 144
 145 .SH "DOCUMENTATION"
 146
 147
 148 Documentation by Matthias Urlichs <smurf@smurf\&.noris\&.de>\&.
 149
 150 .SH "GIT"
 151
 152
 153 Part of the \fBgit\fR(7) suite
 154