blob: 182f6db7a08e5d03b571f54bf85eb0fc77db4276 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 7.0.2" />
<style type="text/css">
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
/*
border: 1px solid red;
*/
}
body {
margin: 1em 5% 1em 5%;
}
a { color: blue; }
a:visited { color: fuchsia; }
em {
font-style: italic;
}
strong {
font-weight: bold;
}
tt {
color: navy;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
font-family: sans-serif;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1 {
border-bottom: 2px solid silver;
}
h2 {
border-bottom: 2px solid silver;
padding-top: 0.5em;
}
div.sectionbody {
font-family: serif;
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
pre {
padding: 0;
margin: 0;
}
span#author {
color: #527bbd;
font-family: sans-serif;
font-weight: bold;
font-size: 1.2em;
}
span#email {
}
span#revision {
font-family: sans-serif;
}
div#footer {
font-family: sans-serif;
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
div#footer-text {
float: left;
padding-bottom: 0.5em;
}
div#footer-badges {
float: right;
padding-bottom: 0.5em;
}
div#preamble,
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-right: 10%;
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.5em;
margin-bottom: 2.5em;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
font-family: sans-serif;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.listingblock > div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock > div.content {
padding-left: 2.0em;
}
div.quoteblock .attribution {
text-align: right;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 2px solid silver;
}
div.exampleblock > div.content {
border-left: 2px solid silver;
padding: 0.5em;
}
div.verseblock div.content {
white-space: pre;
}
div.imageblock div.content { padding-left: 0; }
div.imageblock img { border: 1px solid silver; }
span.image img { border-style: none; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: italic;
}
dd > *:first-child {
margin-top: 0;
}
ul, ol {
list-style-position: outside;
}
ol.olist2 {
list-style-type: lower-alpha;
}
div.tableblock > table {
border-color: #527bbd;
border-width: 3px;
}
thead {
font-family: sans-serif;
font-weight: bold;
}
tfoot {
font-weight: bold;
}
div.hlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
td.hlist1 {
vertical-align: top;
font-style: italic;
padding-right: 0.8em;
}
td.hlist2 {
vertical-align: top;
}
@media print {
div#footer-badges { display: none; }
}
include::./stylesheets/xhtml11-manpage.css[]
/* Workarounds for IE6's broken and incomplete CSS2. */
div.sidebar-content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.sidebar-title, div.image-title {
font-family: sans-serif;
font-weight: bold;
margin-top: 0.0em;
margin-bottom: 0.5em;
}
div.listingblock div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock-content {
padding-left: 2.0em;
}
div.exampleblock-content {
border-left: 2px solid silver;
padding-left: 0.5em;
}
</style>
<title>git-cvsimport(1)</title>
</head>
<body>
<div id="header">
<h1>
git-cvsimport(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>git-cvsimport -
Import a CVS repository into git
</p>
</div>
</div>
<h2>SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
<div class="content"><em>git-cvsimport</em> [-o &lt;branch-for-HEAD&gt;] [-h] [-v] [-d &lt;CVSROOT&gt;] [-s &lt;subst&gt;]
[-p &lt;options-for-cvsps&gt;] [-C &lt;git_repository&gt;] [-i] [-P &lt;file&gt;]
[-m] [-M regex] [&lt;CVS_module&gt;]</div></div>
</div>
<h2>DESCRIPTION</h2>
<div class="sectionbody">
<p>Imports a CVS repository into git. It will either create a new
repository, or incrementally import into an existing one.</p>
<p>Splitting the CVS log into patch sets is done by <em>cvsps</em>.
At least version 2.1 is required.</p>
<p>You should <strong>never</strong> do any work of your own on the branches that are
created by git-cvsimport. The initial import will create and populate a
"master" branch from the CVS repository's main branch which you're free
to work with; after that, you need to <em>git merge</em> incremental imports, or
any CVS branches, yourself.</p>
</div>
<h2>OPTIONS</h2>
<div class="sectionbody">
<dl>
<dt>
-d &lt;CVSROOT&gt;
</dt>
<dd>
<p>
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.
</p>
</dd>
<dt>
-C &lt;target-dir&gt;
</dt>
<dd>
<p>
The git repository to import to. If the directory doesn't
exist, it will be created. Default is the current directory.
</p>
</dd>
<dt>
-i
</dt>
<dd>
<p>
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.
</p>
</dd>
<dt>
-k
</dt>
<dd>
<p>
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.
</p>
</dd>
<dt>
-u
</dt>
<dd>
<p>
Convert underscores in tag and branch names to dots.
</p>
</dd>
<dt>
-o &lt;branch-for-HEAD&gt;
</dt>
<dd>
<p>
The <em>HEAD</em> branch from CVS is imported to the <em>origin</em> branch within
the git repository, as <em>HEAD</em> already has a special meaning for git.
Use this option if you want to import into a different branch.
</p>
<p>Use <em>-o master</em> for continuing an import that was initially done by
the old cvs2git tool.</p>
</dd>
<dt>
-p &lt;options-for-cvsps&gt;
</dt>
<dd>
<p>
Additional options for cvsps.
The options <em>-u</em> and <em>-A</em> are implicit and should not be used here.
</p>
<p>If you need to pass multiple options, separate them with a comma.</p>
</dd>
<dt>
-P &lt;cvsps-output-file&gt;
</dt>
<dd>
<p>
Instead of calling cvsps, read the provided cvsps output file. Useful
for debugging or when cvsps is being handled outside cvsimport.
</p>
</dd>
<dt>
-m
</dt>
<dd>
<p>
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.
</p>
</dd>
<dt>
-M &lt;regex&gt;
</dt>
<dd>
<p>
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.
</p>
</dd>
<dt>
-v
</dt>
<dd>
<p>
Verbosity: let <em>cvsimport</em> report what it is doing.
</p>
</dd>
<dt>
&lt;CVS_module&gt;
</dt>
<dd>
<p>
The CVS module you want to import. Relative to &lt;CVSROOT&gt;.
</p>
</dd>
<dt>
-h
</dt>
<dd>
<p>
Print a short usage message and exit.
</p>
</dd>
<dt>
-z &lt;fuzz&gt;
</dt>
<dd>
<p>
Pass the timestamp fuzz factor to cvsps.
</p>
</dd>
<dt>
-s &lt;subst&gt;
</dt>
<dd>
<p>
Substitute the character "/" in branch names with &lt;subst&gt;
</p>
</dd>
<dt>
-A &lt;author-conv-file&gt;
</dt>
<dd>
<p>
CVS by default uses the unix username when writing its
commit logs. Using this option and an author-conv-file
in this format
</p>
<div class="listingblock">
<div class="content">
<pre><tt> exon=Andreas Ericsson &lt;ae@op5.se&gt;
spawn=Simon Pawn &lt;spawn@frog-pond.org&gt;
</tt></pre>
</div></div>
<p>git-cvsimport will make it appear as those authors had
their GIT_AUTHOR_NAME and GIT_AUTHOR_EMAIL set properly
all along.</p>
<p>For convenience, this data is saved to $GIT_DIR/cvs-authors
each time the -A option is provided and read from that same
file each time git-cvsimport is run.</p>
<p>It is not recommended to use this feature if you intend to
export changes back to CVS again later with
<a href="git-cvsexportcommit.html">git-cvsexportcommit(1)</a>.</p>
</dd>
</dl>
</div>
<h2>OUTPUT</h2>
<div class="sectionbody">
<p>If <em>-v</em> is specified, the script reports what it is doing.</p>
<p>Otherwise, success is indicated the Unix way, i.e. by simply exiting with
a zero exit status.</p>
</div>
<h2>Author</h2>
<div class="sectionbody">
<p>Written by Matthias Urlichs &lt;smurf@smurf.noris.de&gt;, with help from
various participants of the git-list &lt;git@vger.kernel.org&gt;.</p>
</div>
<h2>Documentation</h2>
<div class="sectionbody">
<p>Documentation by Matthias Urlichs &lt;smurf@smurf.noris.de&gt;.</p>
</div>
<h2>GIT</h2>
<div class="sectionbody">
<p>Part of the <a href="git.html">git(7)</a> suite</p>
</div>
<div id="footer">
<div id="footer-text">
Last updated 03-Oct-2006 08:40:59 UTC
</div>
</div>
</body>
</html>