@matheusbsbs / matheus-bagliano / commits / 7b14b3c580
Fork 0

cvsimport: Reorder options in documentation for better understanding

The current order the options are documented in makes no sense at all to me. Reorder them so that similar options are grouped together and also order them somehwhat by importance. Signed-off-by: Frank Lichtenheld <frank@lichtenheld.de> Signed-off-by: Junio C Hamano <junkio@cox.net>

Frank Lichtenheld committed Apr 6, 2007 at 23:52 UTC 7b14b3c58034bdba3a5919e0e4536647c293f6cf
1 file changed +27 -27
Documentation/git-cvsimport.txt
+27 -27
@@ -32,6 +32,9 @@ any CVS branches, yourself.
32
33 OPTIONS
34 -------
35 +-v::
36 + Verbosity: let 'cvsimport' report what it is doing.
37 +
38 -d <CVSROOT>::
39 The root of the CVS archive. May be local (a simple path) or remote;
40 currently, only the :local:, :ext: and :pserver: access methods
@@ -39,10 +42,23 @@ OPTIONS
42 from `CVS/Root`. If no such file exists, it checks for the
43 `CVSROOT` environment variable.
44
45 +<CVS_module>::
46 + The CVS module you want to import. Relative to <CVSROOT>.
47 + If not given, git-cvsimport tries to read it from
48 + `CVS/Repository`.
49 +
50 -C <target-dir>::
51 The git repository to import to. If the directory doesn't
52 exist, it will be created. Default is the current directory.
53
54 +-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.
58 ++
59 +Use '-o master' for continuing an import that was initially done by
60 +the old cvs2git tool.
61 +
62 -i::
63 Import-only: don't perform a checkout after importing. This option
64 ensures the working directory and index remain untouched and will
@@ -56,13 +72,8 @@ OPTIONS
72 -u::
73 Convert underscores in tag and branch names to dots.
74
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 -+
64 -Use '-o master' for continuing an import that was initially done by
65 -the old cvs2git tool.
75 +-s <subst>::
76 + Substitute the character "/" in branch names with <subst>
77
78 -p <options-for-cvsps>::
79 Additional options for cvsps.
@@ -70,6 +81,10 @@ the old cvs2git tool.
81 +
82 If you need to pass multiple options, separate them with a comma.
83
84 +-z <fuzz>::
85 + Pass the timestamp fuzz factor to cvsps, in seconds. If unset,
86 + cvsps defaults to 300s.
87 +
88 -P <cvsps-output-file>::
89 Instead of calling cvsps, read the provided cvsps output file. Useful
90 for debugging or when cvsps is being handled outside cvsimport.
@@ -84,31 +99,13 @@ If you need to pass multiple options, separate them with a comma.
99 regex. It can be used with -m to also see the default regexes.
100 You must escape forward slashes.
101
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>
102 +-S <regex>::
103 + Skip paths matching the regex.
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 -
109 -L <limit>::
110 Limit the number of commits imported. Workaround for cases where
111 cvsimport leaks memory.
@@ -136,6 +133,9 @@ It is not recommended to use this feature if you intend to
133 export changes back to CVS again later with
134 gitlink:git-cvsexportcommit[1].
135
136 +-h::
137 + Print a short usage message and exit.
138 +
139 OUTPUT
140 ------
141 If '-v' is specified, the script reports what it is doing.