@matheusbsbs / matheus-bagliano / commits / cbc9be5ca3
Fork 0

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>

Andy Whitcroft committed Jun 4, 2007 at 10:01 UTC cbc9be5ca3989e522f6ad0dfe3697657ecb4b595
2 files changed +18 -7
Documentation/git-cvsimport.txt
+17 -6
@@ -13,7 +13,7 @@ SYNOPSIS
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>]
16 + [-r <remote>] [<CVS_module>]
17
18
19 DESCRIPTION
@@ -25,10 +25,12 @@ Splitting the CVS log into patch sets is done by 'cvsps'.
25 At least version 2.1 is required.
26
27 You should *never* do any work of your own on the branches that are
28 -created by git-cvsimport. The initial import will create and populate a
28 +created by git-cvsimport. By default initial import will create and populate a
29 "master" branch from the CVS repository's main branch which you're free
30 to work with; after that, you need to 'git merge' incremental imports, or
31 -any CVS branches, yourself.
31 +any CVS branches, yourself. It is advisable to specify a named remote via
32 +-r to separate and protect the incoming branches.
33 +
34
35 OPTIONS
36 -------
@@ -51,10 +53,19 @@ OPTIONS
53 The git repository to import to. If the directory doesn't
54 exist, it will be created. Default is the current directory.
55
56 +-r <remote>::
57 + The git remote to import this CVS repository into.
58 + Moves all CVS branches into remotes/<remote>/<branch>
59 + akin to the git-clone --use-separate-remote option.
60 +
61 -o <branch-for-HEAD>::
55 - The 'HEAD' branch from CVS is imported to the 'origin' branch within
56 - the git repository, as 'HEAD' already has a special meaning for git.
57 - Use this option if you want to import into a different branch.
62 + When no remote is specified (via -r) the 'HEAD' branch
63 + from CVS is imported to the 'origin' branch within the git
64 + repository, as 'HEAD' already has a special meaning for git.
65 + When a remote is specified the 'HEAD' branch is named
66 + remotes/<remote>/master mirroring git-clone behaviour.
67 + Use this option if you want to import into a different
68 + branch.
69 +
70 Use '-o master' for continuing an import that was initially done by
71 the old cvs2git tool.
git-cvsimport.perl
+1 -1
@@ -40,7 +40,7 @@ Usage: ${\basename $0} # fetch/update GIT from CVS
40 [-o branch-for-HEAD] [-h] [-v] [-d CVSROOT] [-A author-conv-file]
41 [-p opts-for-cvsps] [-P file] [-C GIT_repository] [-z fuzz] [-i] [-k]
42 [-u] [-s subst] [-a] [-m] [-M regex] [-S regex] [-L commitlimit]
43 - [CVS_module]
43 + [-r remote] [CVS_module]
44 END
45 exit(1);
46 }