git-cvsimport.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
   4 <head>\r
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
   6 <meta name="generator" content="AsciiDoc 7.0.2" />\r
   7 <style type="text/css">\r
   8 /* Debug borders */\r
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
  10 /*\r
  11   border: 1px solid red;\r
  12 */\r
  13 }\r
  14 \r
  15 body {\r
  16   margin: 1em 5% 1em 5%;\r
  17 }\r
  18 \r
  19 a { color: blue; }\r
  20 a:visited { color: fuchsia; }\r
  21 \r
  22 em {\r
  23   font-style: italic;\r
  24 }\r
  25 \r
  26 strong {\r
  27   font-weight: bold;\r
  28 }\r
  29 \r
  30 tt {\r
  31   color: navy;\r
  32 }\r
  33 \r
  34 h1, h2, h3, h4, h5, h6 {\r
  35   color: #527bbd;\r
  36   font-family: sans-serif;\r
  37   margin-top: 1.2em;\r
  38   margin-bottom: 0.5em;\r
  39   line-height: 1.3;\r
  40 }\r
  41 \r
  42 h1 {\r
  43   border-bottom: 2px solid silver;\r
  44 }\r
  45 h2 {\r
  46   border-bottom: 2px solid silver;\r
  47   padding-top: 0.5em;\r
  48 }\r
  49 \r
  50 div.sectionbody {\r
  51   font-family: serif;\r
  52   margin-left: 0;\r
  53 }\r
  54 \r
  55 hr {\r
  56   border: 1px solid silver;\r
  57 }\r
  58 \r
  59 p {\r
  60   margin-top: 0.5em;\r
  61   margin-bottom: 0.5em;\r
  62 }\r
  63 \r
  64 pre {\r
  65   padding: 0;\r
  66   margin: 0;\r
  67 }\r
  68 \r
  69 span#author {\r
  70   color: #527bbd;\r
  71   font-family: sans-serif;\r
  72   font-weight: bold;\r
  73   font-size: 1.2em;\r
  74 }\r
  75 span#email {\r
  76 }\r
  77 span#revision {\r
  78   font-family: sans-serif;\r
  79 }\r
  80 \r
  81 div#footer {\r
  82   font-family: sans-serif;\r
  83   font-size: small;\r
  84   border-top: 2px solid silver;\r
  85   padding-top: 0.5em;\r
  86   margin-top: 4.0em;\r
  87 }\r
  88 div#footer-text {\r
  89   float: left;\r
  90   padding-bottom: 0.5em;\r
  91 }\r
  92 div#footer-badges {\r
  93   float: right;\r
  94   padding-bottom: 0.5em;\r
  95 }\r
  96 \r
  97 div#preamble,\r
  98 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
  99 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
 100 div.admonitionblock {\r
 101   margin-right: 10%;\r
 102   margin-top: 1.5em;\r
 103   margin-bottom: 1.5em;\r
 104 }\r
 105 div.admonitionblock {\r
 106   margin-top: 2.5em;\r
 107   margin-bottom: 2.5em;\r
 108 }\r
 109 \r
 110 div.content { /* Block element content. */\r
 111   padding: 0;\r
 112 }\r
 113 \r
 114 /* Block element titles. */\r
 115 div.title, caption.title {\r
 116   font-family: sans-serif;\r
 117   font-weight: bold;\r
 118   text-align: left;\r
 119   margin-top: 1.0em;\r
 120   margin-bottom: 0.5em;\r
 121 }\r
 122 div.title + * {\r
 123   margin-top: 0;\r
 124 }\r
 125 \r
 126 td div.title:first-child {\r
 127   margin-top: 0.0em;\r
 128 }\r
 129 div.content div.title:first-child {\r
 130   margin-top: 0.0em;\r
 131 }\r
 132 div.content + div.title {\r
 133   margin-top: 0.0em;\r
 134 }\r
 135 \r
 136 div.sidebarblock > div.content {\r
 137   background: #ffffee;\r
 138   border: 1px solid silver;\r
 139   padding: 0.5em;\r
 140 }\r
 141 \r
 142 div.listingblock > div.content {\r
 143   border: 1px solid silver;\r
 144   background: #f4f4f4;\r
 145   padding: 0.5em;\r
 146 }\r
 147 \r
 148 div.quoteblock > div.content {\r
 149   padding-left: 2.0em;\r
 150 }\r
 151 div.quoteblock .attribution {\r
 152   text-align: right;\r
 153 }\r
 154 \r
 155 div.admonitionblock .icon {\r
 156   vertical-align: top;\r
 157   font-size: 1.1em;\r
 158   font-weight: bold;\r
 159   text-decoration: underline;\r
 160   color: #527bbd;\r
 161   padding-right: 0.5em;\r
 162 }\r
 163 div.admonitionblock td.content {\r
 164   padding-left: 0.5em;\r
 165   border-left: 2px solid silver;\r
 166 }\r
 167 \r
 168 div.exampleblock > div.content {\r
 169   border-left: 2px solid silver;\r
 170   padding: 0.5em;\r
 171 }\r
 172 \r
 173 div.verseblock div.content {\r
 174   white-space: pre;\r
 175 }\r
 176 \r
 177 div.imageblock div.content { padding-left: 0; }\r
 178 div.imageblock img { border: 1px solid silver; }\r
 179 span.image img { border-style: none; }\r
 180 \r
 181 dl {\r
 182   margin-top: 0.8em;\r
 183   margin-bottom: 0.8em;\r
 184 }\r
 185 dt {\r
 186   margin-top: 0.5em;\r
 187   margin-bottom: 0;\r
 188   font-style: italic;\r
 189 }\r
 190 dd > *:first-child {\r
 191   margin-top: 0;\r
 192 }\r
 193 \r
 194 ul, ol {\r
 195     list-style-position: outside;\r
 196 }\r
 197 ol.olist2 {\r
 198   list-style-type: lower-alpha;\r
 199 }\r
 200 \r
 201 div.tableblock > table {\r
 202   border-color: #527bbd;\r
 203   border-width: 3px;\r
 204 }\r
 205 thead {\r
 206   font-family: sans-serif;\r
 207   font-weight: bold;\r
 208 }\r
 209 tfoot {\r
 210   font-weight: bold;\r
 211 }\r
 212 \r
 213 div.hlist {\r
 214   margin-top: 0.8em;\r
 215   margin-bottom: 0.8em;\r
 216 }\r
 217 td.hlist1 {\r
 218   vertical-align: top;\r
 219   font-style: italic;\r
 220   padding-right: 0.8em;\r
 221 }\r
 222 td.hlist2 {\r
 223   vertical-align: top;\r
 224 }\r
 225 \r
 226 @media print {\r
 227   div#footer-badges { display: none; }\r
 228 }\r
 229 include::./stylesheets/xhtml11-manpage.css[]\r
 230 /* Workarounds for IE6's broken and incomplete CSS2. */\r
 231 \r
 232 div.sidebar-content {\r
 233   background: #ffffee;\r
 234   border: 1px solid silver;\r
 235   padding: 0.5em;\r
 236 }\r
 237 div.sidebar-title, div.image-title {\r
 238   font-family: sans-serif;\r
 239   font-weight: bold;\r
 240   margin-top: 0.0em;\r
 241   margin-bottom: 0.5em;\r
 242 }\r
 243 \r
 244 div.listingblock div.content {\r
 245   border: 1px solid silver;\r
 246   background: #f4f4f4;\r
 247   padding: 0.5em;\r
 248 }\r
 249 \r
 250 div.quoteblock-content {\r
 251   padding-left: 2.0em;\r
 252 }\r
 253 \r
 254 div.exampleblock-content {\r
 255   border-left: 2px solid silver;\r
 256   padding-left: 0.5em;\r
 257 }\r
 258 </style>\r
 259 <title>git-cvsimport(1)</title>\r
 260 </head>\r
 261 <body>\r
 262 <div id="header">\r
 263 <h1>\r
 264 git-cvsimport(1) Manual Page\r
 265 </h1>\r
 266 <h2>NAME</h2>\r
 267 <div class="sectionbody">\r
 268 <p>git-cvsimport -\r
 269    Import a CVS repository into git\r
 270 </p>\r
 271 </div>\r
 272 </div>\r
 273 <h2>SYNOPSIS</h2>\r
 274 <div class="sectionbody">\r
 275 <div class="verseblock">\r
 276 <div class="content"><em>git-cvsimport</em> [-o &lt;branch-for-HEAD&gt;] [-h] [-v] [-d &lt;CVSROOT&gt;] [-s &lt;subst&gt;]\r
 277               [-p &lt;options-for-cvsps&gt;] [-C &lt;git_repository&gt;] [-i] [-P &lt;file&gt;]\r
 278               [-m] [-M regex] [&lt;CVS_module&gt;]</div></div>\r
 279 </div>\r
 280 <h2>DESCRIPTION</h2>\r
 281 <div class="sectionbody">\r
 282 <p>Imports a CVS repository into git. It will either create a new\r
 283 repository, or incrementally import into an existing one.</p>\r
 284 <p>Splitting the CVS log into patch sets is done by <em>cvsps</em>.\r
 285 At least version 2.1 is required.</p>\r
 286 <p>You should <strong>never</strong> do any work of your own on the branches that are\r
 287 created by git-cvsimport. The initial import will create and populate a\r
 288 "master" branch from the CVS repository's main branch which you're free\r
 289 to work with; after that, you need to <em>git merge</em> incremental imports, or\r
 290 any CVS branches, yourself.</p>\r
 291 </div>\r
 292 <h2>OPTIONS</h2>\r
 293 <div class="sectionbody">\r
 294 <dl>\r
 295 <dt>\r
 296 -d &lt;CVSROOT&gt;\r
 297 </dt>\r
 298 <dd>\r
 299 <p>\r
 300         The root of the CVS archive. May be local (a simple path) or remote;\r
 301         currently, only the :local:, :ext: and :pserver: access methods\r
 302         are supported.\r
 303 </p>\r
 304 </dd>\r
 305 <dt>\r
 306 -C &lt;target-dir&gt;\r
 307 </dt>\r
 308 <dd>\r
 309 <p>\r
 310         The git repository to import to.  If the directory doesn't\r
 311         exist, it will be created.  Default is the current directory.\r
 312 </p>\r
 313 </dd>\r
 314 <dt>\r
 315 -i\r
 316 </dt>\r
 317 <dd>\r
 318 <p>\r
 319         Import-only: don't perform a checkout after importing.  This option\r
 320         ensures the working directory and index remain untouched and will\r
 321         not create them if they do not exist.\r
 322 </p>\r
 323 </dd>\r
 324 <dt>\r
 325 -k\r
 326 </dt>\r
 327 <dd>\r
 328 <p>\r
 329         Kill keywords: will extract files with -kk from the CVS archive\r
 330         to avoid noisy changesets. Highly recommended, but off by default\r
 331         to preserve compatibility with early imported trees.\r
 332 </p>\r
 333 </dd>\r
 334 <dt>\r
 335 -u\r
 336 </dt>\r
 337 <dd>\r
 338 <p>\r
 339         Convert underscores in tag and branch names to dots.\r
 340 </p>\r
 341 </dd>\r
 342 <dt>\r
 343 -o &lt;branch-for-HEAD&gt;\r
 344 </dt>\r
 345 <dd>\r
 346 <p>\r
 347         The <em>HEAD</em> branch from CVS is imported to the <em>origin</em> branch within\r
 348         the git repository, as <em>HEAD</em> already has a special meaning for git.\r
 349         Use this option if you want to import into a different branch.\r
 350 </p>\r
 351 <p>Use <em>-o master</em> for continuing an import that was initially done by\r
 352 the old cvs2git tool.</p>\r
 353 </dd>\r
 354 <dt>\r
 355 -p &lt;options-for-cvsps&gt;\r
 356 </dt>\r
 357 <dd>\r
 358 <p>\r
 359         Additional options for cvsps.\r
 360         The options <em>-u</em> and <em>-A</em> are implicit and should not be used here.\r
 361 </p>\r
 362 <p>If you need to pass multiple options, separate them with a comma.</p>\r
 363 </dd>\r
 364 <dt>\r
 365 -P &lt;cvsps-output-file&gt;\r
 366 </dt>\r
 367 <dd>\r
 368 <p>\r
 369         Instead of calling cvsps, read the provided cvsps output file. Useful\r
 370         for debugging or when cvsps is being handled outside cvsimport.\r
 371 </p>\r
 372 </dd>\r
 373 <dt>\r
 374 -m\r
 375 </dt>\r
 376 <dd>\r
 377 <p>\r
 378         Attempt to detect merges based on the commit message. This option\r
 379         will enable default regexes that try to capture the name source\r
 380         branch name from the commit message.\r
 381 </p>\r
 382 </dd>\r
 383 <dt>\r
 384 -M &lt;regex&gt;\r
 385 </dt>\r
 386 <dd>\r
 387 <p>\r
 388         Attempt to detect merges based on the commit message with a custom\r
 389         regex. It can be used with -m to also see the default regexes.\r
 390         You must escape forward slashes.\r
 391 </p>\r
 392 </dd>\r
 393 <dt>\r
 394 -v\r
 395 </dt>\r
 396 <dd>\r
 397 <p>\r
 398         Verbosity: let <em>cvsimport</em> report what it is doing.\r
 399 </p>\r
 400 </dd>\r
 401 <dt>\r
 402 &lt;CVS_module&gt;\r
 403 </dt>\r
 404 <dd>\r
 405 <p>\r
 406         The CVS module you want to import. Relative to &lt;CVSROOT&gt;.\r
 407 </p>\r
 408 </dd>\r
 409 <dt>\r
 410 -h\r
 411 </dt>\r
 412 <dd>\r
 413 <p>\r
 414         Print a short usage message and exit.\r
 415 </p>\r
 416 </dd>\r
 417 <dt>\r
 418 -z &lt;fuzz&gt;\r
 419 </dt>\r
 420 <dd>\r
 421 <p>\r
 422         Pass the timestamp fuzz factor to cvsps.\r
 423 </p>\r
 424 </dd>\r
 425 <dt>\r
 426 -s &lt;subst&gt;\r
 427 </dt>\r
 428 <dd>\r
 429 <p>\r
 430         Substitute the character "/" in branch names with &lt;subst&gt;\r
 431 </p>\r
 432 </dd>\r
 433 <dt>\r
 434 -A &lt;author-conv-file&gt;\r
 435 </dt>\r
 436 <dd>\r
 437 <p>\r
 438         CVS by default uses the unix username when writing its\r
 439         commit logs. Using this option and an author-conv-file\r
 440         in this format\r
 441 </p>\r
 442 <div class="listingblock">\r
 443 <div class="content">\r
 444 <pre><tt>        exon=Andreas Ericsson &lt;ae@op5.se&gt;\r
 445         spawn=Simon Pawn &lt;spawn@frog-pond.org&gt;\r
 446 </tt></pre>\r
 447 </div></div>\r
 448 <p>git-cvsimport will make it appear as those authors had\r
 449 their GIT_AUTHOR_NAME and GIT_AUTHOR_EMAIL set properly\r
 450 all along.</p>\r
 451 <p>For convenience, this data is saved to $GIT_DIR/cvs-authors\r
 452 each time the -A option is provided and read from that same\r
 453 file each time git-cvsimport is run.</p>\r
 454 <p>It is not recommended to use this feature if you intend to\r
 455 export changes back to CVS again later with\r
 456 git-link[1]::git-cvsexportcommit.</p>\r
 457 </dd>\r
 458 </dl>\r
 459 </div>\r
 460 <h2>OUTPUT</h2>\r
 461 <div class="sectionbody">\r
 462 <p>If <em>-v</em> is specified, the script reports what it is doing.</p>\r
 463 <p>Otherwise, success is indicated the Unix way, i.e. by simply exiting with\r
 464 a zero exit status.</p>\r
 465 </div>\r
 466 <h2>Author</h2>\r
 467 <div class="sectionbody">\r
 468 <p>Written by Matthias Urlichs &lt;smurf@smurf.noris.de&gt;, with help from\r
 469 various participants of the git-list &lt;git@vger.kernel.org&gt;.</p>\r
 470 </div>\r
 471 <h2>Documentation</h2>\r
 472 <div class="sectionbody">\r
 473 <p>Documentation by Matthias Urlichs &lt;smurf@smurf.noris.de&gt;.</p>\r
 474 </div>\r
 475 <h2>GIT</h2>\r
 476 <div class="sectionbody">\r
 477 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
 478 </div>\r
 479 <div id="footer">\r
 480 <div id="footer-text">\r
 481 Last updated 21-Mar-2006 08:33:42 UTC\r
 482 </div>\r
 483 </div>\r
 484 </body>\r
 485 </html>\r