cvsimport: update documentation to include separate remotes option

Document the cvsimport -r <remote> option which switches cvsimport
to using a separate remote for tracking branches.

Signed-off-by: Andy Whitcroft <apw@shadowen.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Andy Whitcroft 2007-06-04 10:01:34 +01:00 committed by Junio C Hamano
parent 8b7f5fc1ca
commit cbc9be5ca3
2 changed files with 18 additions and 7 deletions

View File

@ -13,7 +13,7 @@ SYNOPSIS
[-A <author-conv-file>] [-p <options-for-cvsps>] [-P <file>] [-A <author-conv-file>] [-p <options-for-cvsps>] [-P <file>]
[-C <git_repository>] [-z <fuzz>] [-i] [-k] [-u] [-s <subst>] [-C <git_repository>] [-z <fuzz>] [-i] [-k] [-u] [-s <subst>]
[-a] [-m] [-M <regex>] [-S <regex>] [-L <commitlimit>] [-a] [-m] [-M <regex>] [-S <regex>] [-L <commitlimit>]
[<CVS_module>] [-r <remote>] [<CVS_module>]
DESCRIPTION DESCRIPTION
@ -25,10 +25,12 @@ Splitting the CVS log into patch sets is done by 'cvsps'.
At least version 2.1 is required. At least version 2.1 is required.
You should *never* do any work of your own on the branches that are You should *never* do any work of your own on the branches that are
created by git-cvsimport. The 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 "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. any CVS branches, yourself. It is advisable to specify a named remote via
-r to separate and protect the incoming branches.
OPTIONS OPTIONS
------- -------
@ -51,10 +53,19 @@ OPTIONS
The git repository to import to. If the directory doesn't The git repository to import to. If the directory doesn't
exist, it will be created. Default is the current directory. exist, it will be created. Default is the current directory.
-r <remote>::
The git remote to import this CVS repository into.
Moves all CVS branches into remotes/<remote>/<branch>
akin to the git-clone --use-separate-remote option.
-o <branch-for-HEAD>:: -o <branch-for-HEAD>::
The 'HEAD' branch from CVS is imported to the 'origin' branch within When no remote is specified (via -r) the 'HEAD' branch
the git repository, as 'HEAD' already has a special meaning for git. from CVS is imported to the 'origin' branch within the git
Use this option if you want to import into a different branch. repository, as 'HEAD' already has a special meaning for git.
When a remote is specified the 'HEAD' branch is named
remotes/<remote>/master mirroring git-clone behaviour.
Use this option if you want to import into a different
branch.
+ +
Use '-o master' for continuing an import that was initially done by Use '-o master' for continuing an import that was initially done by
the old cvs2git tool. the old cvs2git tool.

View File

@ -40,7 +40,7 @@ Usage: ${\basename $0} # fetch/update GIT from CVS
[-o branch-for-HEAD] [-h] [-v] [-d CVSROOT] [-A author-conv-file] [-o branch-for-HEAD] [-h] [-v] [-d CVSROOT] [-A author-conv-file]
[-p opts-for-cvsps] [-P file] [-C GIT_repository] [-z fuzz] [-i] [-k] [-p opts-for-cvsps] [-P file] [-C GIT_repository] [-z fuzz] [-i] [-k]
[-u] [-s subst] [-a] [-m] [-M regex] [-S regex] [-L commitlimit] [-u] [-s subst] [-a] [-m] [-M regex] [-S regex] [-L commitlimit]
[CVS_module] [-r remote] [CVS_module]
END END
exit(1); exit(1);
} }