doc/source/en/TortoiseGit/git_doc/git-cvsimport.html.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
   3 \r
   4 <article lang="en" id="git-cvsimport(1)">\r
   5 <articleinfo>\r
   6     <title>git-cvsimport(1)</title>\r
   7         <indexterm>\r
   8                 <primary>git-cvsimport(1)</primary>\r
   9         </indexterm>\r
  10 </articleinfo>\r
  11 <simplesect id="_name">\r
  12 <title>NAME</title>\r
  13 <simpara>git-cvsimport - Salvage your data out of another SCM people love to hate</simpara>\r
  14 </simplesect>\r
  15 <simplesect id="_synopsis">\r
  16 <title>SYNOPSIS</title>\r
  17 <blockquote>\r
  18 <literallayout><emphasis>git cvsimport</emphasis> [-o &lt;branch-for-HEAD&gt;] [-h] [-v] [-d &lt;CVSROOT&gt;]\r
  19               [-A &lt;author-conv-file&gt;] [-p &lt;options-for-cvsps&gt;] [-P &lt;file&gt;]\r
  20               [-C &lt;git_repository&gt;] [-z &lt;fuzz&gt;] [-i] [-k] [-u] [-s &lt;subst&gt;]\r
  21               [-a] [-m] [-M &lt;regex&gt;] [-S &lt;regex&gt;] [-L &lt;commitlimit&gt;]\r
  22               [-r &lt;remote&gt;] [&lt;CVS_module&gt;]</literallayout>\r
  23 </blockquote>\r
  24 </simplesect>\r
  25 <simplesect id="_description">\r
  26 <title>DESCRIPTION</title>\r
  27 <simpara>Imports a CVS repository into git. It will either create a new\r
  28 repository, or incrementally import into an existing one.</simpara>\r
  29 <simpara>Splitting the CVS log into patch sets is done by <emphasis>cvsps</emphasis>.\r
  30 At least version 2.1 is required.</simpara>\r
  31 <simpara>You should <emphasis role="strong">never</emphasis> do any work of your own on the branches that are\r
  32 created by <emphasis>git-cvsimport</emphasis>.  By default initial import will create and populate a\r
  33 "master" branch from the CVS repository&#8217;s main branch which you&#8217;re free\r
  34 to work with; after that, you need to <emphasis>git-merge</emphasis> incremental imports, or\r
  35 any CVS branches, yourself.  It is advisable to specify a named remote via\r
  36 -r to separate and protect the incoming branches.</simpara>\r
  37 <simpara>If you intend to set up a shared public repository that all developers can\r
  38 read/write, or if you want to use <xref linkend="git-cvsserver(1)"/>, then you\r
  39 probably want to make a bare clone of the imported repository,\r
  40 and use the clone as the shared repository.\r
  41 See <xref linkend="gitcvs-migration(7)"/>.</simpara>\r
  42 </simplesect>\r
  43 <simplesect id="_options">\r
  44 <title>OPTIONS</title>\r
  45 <variablelist>\r
  46 <varlistentry>\r
  47 <term>\r
  48 -v\r
  49 </term>\r
  50 <listitem>\r
  51 <simpara>\r
  52         Verbosity: let <emphasis>cvsimport</emphasis> report what it is doing.\r
  53 </simpara>\r
  54 </listitem>\r
  55 </varlistentry>\r
  56 <varlistentry>\r
  57 <term>\r
  58 -d &lt;CVSROOT&gt;\r
  59 </term>\r
  60 <listitem>\r
  61 <simpara>\r
  62         The root of the CVS archive. May be local (a simple path) or remote;\r
  63         currently, only the :local:, :ext: and :pserver: access methods\r
  64         are supported. If not given, <emphasis>git-cvsimport</emphasis> will try to read it\r
  65         from <literal>CVS/Root</literal>. If no such file exists, it checks for the\r
  66         <literal>CVSROOT</literal> environment variable.\r
  67 </simpara>\r
  68 </listitem>\r
  69 </varlistentry>\r
  70 <varlistentry>\r
  71 <term>\r
  72 &lt;CVS_module&gt;\r
  73 </term>\r
  74 <listitem>\r
  75 <simpara>\r
  76         The CVS module you want to import. Relative to &lt;CVSROOT&gt;.\r
  77         If not given, <emphasis>git-cvsimport</emphasis> tries to read it from\r
  78         <literal>CVS/Repository</literal>.\r
  79 </simpara>\r
  80 </listitem>\r
  81 </varlistentry>\r
  82 <varlistentry>\r
  83 <term>\r
  84 -C &lt;target-dir&gt;\r
  85 </term>\r
  86 <listitem>\r
  87 <simpara>\r
  88         The git repository to import to.  If the directory doesn&#8217;t\r
  89         exist, it will be created.  Default is the current directory.\r
  90 </simpara>\r
  91 </listitem>\r
  92 </varlistentry>\r
  93 <varlistentry>\r
  94 <term>\r
  95 -r &lt;remote&gt;\r
  96 </term>\r
  97 <listitem>\r
  98 <simpara>\r
  99         The git remote to import this CVS repository into.\r
 100         Moves all CVS branches into remotes/&lt;remote&gt;/&lt;branch&gt;\r
 101         akin to the <emphasis>git-clone</emphasis> "--use-separate-remote" option.\r
 102 </simpara>\r
 103 </listitem>\r
 104 </varlistentry>\r
 105 <varlistentry>\r
 106 <term>\r
 107 -o &lt;branch-for-HEAD&gt;\r
 108 </term>\r
 109 <listitem>\r
 110 <simpara>\r
 111         When no remote is specified (via -r) the <emphasis>HEAD</emphasis> branch\r
 112         from CVS is imported to the <emphasis>origin</emphasis> branch within the git\r
 113         repository, as <emphasis>HEAD</emphasis> already has a special meaning for git.\r
 114         When a remote is specified the <emphasis>HEAD</emphasis> branch is named\r
 115         remotes/&lt;remote&gt;/master mirroring <emphasis>git-clone</emphasis> behaviour.\r
 116         Use this option if you want to import into a different\r
 117         branch.\r
 118 </simpara>\r
 119 <simpara>Use <emphasis>-o master</emphasis> for continuing an import that was initially done by\r
 120 the old cvs2git tool.</simpara>\r
 121 </listitem>\r
 122 </varlistentry>\r
 123 <varlistentry>\r
 124 <term>\r
 125 -i\r
 126 </term>\r
 127 <listitem>\r
 128 <simpara>\r
 129         Import-only: don&#8217;t perform a checkout after importing.  This option\r
 130         ensures the working directory and index remain untouched and will\r
 131         not create them if they do not exist.\r
 132 </simpara>\r
 133 </listitem>\r
 134 </varlistentry>\r
 135 <varlistentry>\r
 136 <term>\r
 137 -k\r
 138 </term>\r
 139 <listitem>\r
 140 <simpara>\r
 141         Kill keywords: will extract files with <emphasis>-kk</emphasis> from the CVS archive\r
 142         to avoid noisy changesets. Highly recommended, but off by default\r
 143         to preserve compatibility with early imported trees.\r
 144 </simpara>\r
 145 </listitem>\r
 146 </varlistentry>\r
 147 <varlistentry>\r
 148 <term>\r
 149 -u\r
 150 </term>\r
 151 <listitem>\r
 152 <simpara>\r
 153         Convert underscores in tag and branch names to dots.\r
 154 </simpara>\r
 155 </listitem>\r
 156 </varlistentry>\r
 157 <varlistentry>\r
 158 <term>\r
 159 -s &lt;subst&gt;\r
 160 </term>\r
 161 <listitem>\r
 162 <simpara>\r
 163         Substitute the character "/" in branch names with &lt;subst&gt;\r
 164 </simpara>\r
 165 </listitem>\r
 166 </varlistentry>\r
 167 <varlistentry>\r
 168 <term>\r
 169 -p &lt;options-for-cvsps&gt;\r
 170 </term>\r
 171 <listitem>\r
 172 <simpara>\r
 173         Additional options for cvsps.\r
 174         The options <emphasis>-u</emphasis> and <emphasis>-A</emphasis> are implicit and should not be used here.\r
 175 </simpara>\r
 176 <simpara>If you need to pass multiple options, separate them with a comma.</simpara>\r
 177 </listitem>\r
 178 </varlistentry>\r
 179 <varlistentry>\r
 180 <term>\r
 181 -z &lt;fuzz&gt;\r
 182 </term>\r
 183 <listitem>\r
 184 <simpara>\r
 185         Pass the timestamp fuzz factor to cvsps, in seconds. If unset,\r
 186         cvsps defaults to 300s.\r
 187 </simpara>\r
 188 </listitem>\r
 189 </varlistentry>\r
 190 <varlistentry>\r
 191 <term>\r
 192 -P &lt;cvsps-output-file&gt;\r
 193 </term>\r
 194 <listitem>\r
 195 <simpara>\r
 196         Instead of calling cvsps, read the provided cvsps output file. Useful\r
 197         for debugging or when cvsps is being handled outside cvsimport.\r
 198 </simpara>\r
 199 </listitem>\r
 200 </varlistentry>\r
 201 <varlistentry>\r
 202 <term>\r
 203 -m\r
 204 </term>\r
 205 <listitem>\r
 206 <simpara>\r
 207         Attempt to detect merges based on the commit message. This option\r
 208         will enable default regexes that try to capture the source\r
 209         branch name from the commit message.\r
 210 </simpara>\r
 211 </listitem>\r
 212 </varlistentry>\r
 213 <varlistentry>\r
 214 <term>\r
 215 -M &lt;regex&gt;\r
 216 </term>\r
 217 <listitem>\r
 218 <simpara>\r
 219         Attempt to detect merges based on the commit message with a custom\r
 220         regex. It can be used with <emphasis>-m</emphasis> to enable the default regexes\r
 221         as well. You must escape forward slashes.\r
 222 </simpara>\r
 223 <simpara>The regex must capture the source branch name in $1.</simpara>\r
 224 <simpara>This option can be used several times to provide several detection regexes.</simpara>\r
 225 </listitem>\r
 226 </varlistentry>\r
 227 <varlistentry>\r
 228 <term>\r
 229 -S &lt;regex&gt;\r
 230 </term>\r
 231 <listitem>\r
 232 <simpara>\r
 233         Skip paths matching the regex.\r
 234 </simpara>\r
 235 </listitem>\r
 236 </varlistentry>\r
 237 <varlistentry>\r
 238 <term>\r
 239 -a\r
 240 </term>\r
 241 <listitem>\r
 242 <simpara>\r
 243         Import all commits, including recent ones. cvsimport by default\r
 244         skips commits that have a timestamp less than 10 minutes ago.\r
 245 </simpara>\r
 246 </listitem>\r
 247 </varlistentry>\r
 248 <varlistentry>\r
 249 <term>\r
 250 -L &lt;limit&gt;\r
 251 </term>\r
 252 <listitem>\r
 253 <simpara>\r
 254         Limit the number of commits imported. Workaround for cases where\r
 255         cvsimport leaks memory.\r
 256 </simpara>\r
 257 </listitem>\r
 258 </varlistentry>\r
 259 <varlistentry>\r
 260 <term>\r
 261 -A &lt;author-conv-file&gt;\r
 262 </term>\r
 263 <listitem>\r
 264 <simpara>\r
 265         CVS by default uses the Unix username when writing its\r
 266         commit logs. Using this option and an author-conv-file\r
 267         in this format\r
 268 </simpara>\r
 269 <literallayout>        exon=Andreas Ericsson &lt;ae@op5.se&gt;\r
 270         spawn=Simon Pawn &lt;spawn@frog-pond.org&gt;</literallayout>\r
 271 <simpara><emphasis>git-cvsimport</emphasis> will make it appear as those authors had\r
 272 their GIT_AUTHOR_NAME and GIT_AUTHOR_EMAIL set properly\r
 273 all along.</simpara>\r
 274 <simpara>For convenience, this data is saved to <literal>$GIT_DIR/cvs-authors</literal>\r
 275 each time the <emphasis>-A</emphasis> option is provided and read from that same\r
 276 file each time <emphasis>git-cvsimport</emphasis> is run.</simpara>\r
 277 <simpara>It is not recommended to use this feature if you intend to\r
 278 export changes back to CVS again later with\r
 279 <emphasis>git-cvsexportcommit</emphasis>.</simpara>\r
 280 </listitem>\r
 281 </varlistentry>\r
 282 <varlistentry>\r
 283 <term>\r
 284 -h\r
 285 </term>\r
 286 <listitem>\r
 287 <simpara>\r
 288         Print a short usage message and exit.\r
 289 </simpara>\r
 290 </listitem>\r
 291 </varlistentry>\r
 292 </variablelist>\r
 293 </simplesect>\r
 294 <simplesect id="_output">\r
 295 <title>OUTPUT</title>\r
 296 <simpara>If <emphasis>-v</emphasis> is specified, the script reports what it is doing.</simpara>\r
 297 <simpara>Otherwise, success is indicated the Unix way, i.e. by simply exiting with\r
 298 a zero exit status.</simpara>\r
 299 </simplesect>\r
 300 <simplesect id="_author">\r
 301 <title>Author</title>\r
 302 <simpara>Written by Matthias Urlichs &lt;<ulink url="mailto:smurf@smurf.noris.de">smurf@smurf.noris.de</ulink>&gt;, with help from\r
 303 various participants of the git-list &lt;<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>&gt;.</simpara>\r
 304 </simplesect>\r
 305 <simplesect id="_documentation">\r
 306 <title>Documentation</title>\r
 307 <simpara>Documentation by Matthias Urlichs &lt;<ulink url="mailto:smurf@smurf.noris.de">smurf@smurf.noris.de</ulink>&gt;.</simpara>\r
 308 </simplesect>\r
 309 <simplesect id="_git">\r
 310 <title>GIT</title>\r
 311 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
 312 </simplesect>\r
 313 </article>\r