X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;ds=sidebyside;f=Documentation%2Fgit-cvsimport.txt;h=ed79bb8d5bcae61d59197083a3e264c83992a4df;hb=877276d4d3018d2810be990c39fa7f59678e960d;hp=6f91b9ea2a17df8fc8e3c00fdf0d5c74a6c17950;hpb=e38f892d1832977511c4e7c82204c7f94c3a3232;p=git.git diff --git a/Documentation/git-cvsimport.txt b/Documentation/git-cvsimport.txt index 6f91b9ea2..ed79bb8d5 100644 --- a/Documentation/git-cvsimport.txt +++ b/Documentation/git-cvsimport.txt @@ -9,7 +9,7 @@ git-cvsimport - Salvage your data out of another SCM people love to hate SYNOPSIS -------- [verse] -'git-cvsimport' [-o ] [-h] [-v] [-d ] +'git cvsimport' [-o ] [-h] [-v] [-d ] [-A ] [-p ] [-P ] [-C ] [-z ] [-i] [-k] [-u] [-s ] [-a] [-m] [-M ] [-S ] [-L ] @@ -25,9 +25,9 @@ Splitting the CVS log into patch sets is done by 'cvsps'. At least version 2.1 is required. You should *never* do any work of your own on the branches that are -created by git-cvsimport. By default initial import will create and populate a +created by `git-cvsimport`. By default 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 'git merge' incremental imports, or +to work with; after that, you need to `git-merge` incremental imports, or any CVS branches, yourself. It is advisable to specify a named remote via -r to separate and protect the incoming branches. @@ -40,13 +40,13 @@ OPTIONS -d :: 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. If not given, git-cvsimport will try to read it + are supported. If not given, `git-cvsimport` will try to read it from `CVS/Root`. If no such file exists, it checks for the `CVSROOT` environment variable. :: The CVS module you want to import. Relative to . - If not given, git-cvsimport tries to read it from + If not given, `git-cvsimport` tries to read it from `CVS/Repository`. -C :: @@ -56,14 +56,14 @@ OPTIONS -r :: The git remote to import this CVS repository into. Moves all CVS branches into remotes// - akin to the git-clone --use-separate-remote option. + akin to the `git-clone` "--use-separate-remote" option. -o :: When no remote is specified (via -r) the 'HEAD' branch from CVS is imported to the 'origin' branch within the git repository, as 'HEAD' already has a special meaning for git. When a remote is specified the 'HEAD' branch is named - remotes//master mirroring git-clone behaviour. + remotes//master mirroring `git-clone` behaviour. Use this option if you want to import into a different branch. + @@ -102,13 +102,17 @@ If you need to pass multiple options, separate them with a comma. -m:: Attempt to detect merges based on the commit message. This option - will enable default regexes that try to capture the name source + will enable default regexes that try to capture the source branch name from the commit message. -M :: Attempt to detect merges based on the commit message with a custom regex. It can be used with '-m' to enable the default regexes as well. You must escape forward slashes. ++ +The regex must capture the source branch name in $1. ++ +This option can be used several times to provide several detection regexes. -S :: Skip paths matching the regex. @@ -132,17 +136,17 @@ If you need to pass multiple options, separate them with a comma. --------- + -git-cvsimport will make it appear as those authors had +`git-cvsimport` will make it appear as those authors had their GIT_AUTHOR_NAME and GIT_AUTHOR_EMAIL set properly all along. + 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. +file each time `git-cvsimport` is run. + It is not recommended to use this feature if you intend to export changes back to CVS again later with -linkgit:git-cvsexportcommit[1]. +`git-cvsexportcommit`. -h:: Print a short usage message and exit. @@ -166,4 +170,4 @@ Documentation by Matthias Urlichs . GIT --- -Part of the linkgit:git[7] suite +Part of the linkgit:git[1] suite