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