git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 4/5] cvsimport: Reorder options in documentation for better understanding

From
Frank Lichtenheld <frank@lichtenheld.de>
Date
Apr 6, 2007, 21:52 UTC
Message-ID
<11758963643062-git-send-email-frank@lichtenheld.de>
In-Reply-To
<11758963642149-git-send-email-frank@lichtenheld.de>

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>
---
 Documentation/git-cvsimport.txt |   54 +++++++++++++++++++-------------------
 1 files changed, 27 insertions(+), 27 deletions(-)
diff --git a/Documentation/git-cvsimport.txt b/Documentation/git-cvsimport.txt
index 6a0821a..a5276f7 100644
--- a/Documentation/git-cvsimport.txt
+++ b/Documentation/git-cvsimport.txt
@@ -32,6 +32,9 @@ any CVS branches, yourself.
 
 OPTIONS
 -------
+-v::
+	Verbosity: let 'cvsimport' report what it is doing.
+
 -d <CVSROOT>::
 	The root of the CVS archive. May be local (a simple path) or remote;
 	currently, only the :local:, :ext: and :pserver: access methods 
@@ -39,10 +42,23 @@ OPTIONS
 	from `CVS/Root`. If no such file exists, it checks for the
 	`CVSROOT` environment variable.
 
+<CVS_module>::
+	The CVS module you want to import. Relative to <CVSROOT>.
+	If not given, git-cvsimport tries to read it from
+	`CVS/Repository`.
+
 -C <target-dir>::
         The git repository to import to.  If the directory doesn't
         exist, it will be created.  Default is the current directory.
 
+-o <branch-for-HEAD>::
+	The 'HEAD' branch from CVS is imported to the 'origin' branch within
+	the git repository, as 'HEAD' already has a special meaning for git.
+	Use this option if you want to import into a different branch.
++
+Use '-o master' for continuing an import that was initially done by
+the old cvs2git tool.
+
 -i::
 	Import-only: don't perform a checkout after importing.  This option
 	ensures the working directory and index remain untouched and will
@@ -56,13 +72,8 @@ OPTIONS
 -u::
 	Convert underscores in tag and branch names to dots.
 
--o <branch-for-HEAD>::
-	The 'HEAD' branch from CVS is imported to the 'origin' branch within
-	the git repository, as 'HEAD' already has a special meaning for git.
-	Use this option if you want to import into a different branch.
-+
-Use '-o master' for continuing an import that was initially done by
-the old cvs2git tool.
+-s <subst>::
+	Substitute the character "/" in branch names with <subst>
 
 -p <options-for-cvsps>::
 	Additional options for cvsps.
@@ -70,6 +81,10 @@ the old cvs2git tool.
 +
 If you need to pass multiple options, separate them with a comma.
 
+-z <fuzz>::
+	Pass the timestamp fuzz factor to cvsps, in seconds. If unset,
+	cvsps defaults to 300s.
+
 -P <cvsps-output-file>::
 	Instead of calling cvsps, read the provided cvsps output file. Useful
 	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.
 	regex. It can be used with -m to also see the default regexes. 
 	You must escape forward slashes. 
 
--v::
-	Verbosity: let 'cvsimport' report what it is doing.
-
-<CVS_module>::
-	The CVS module you want to import. Relative to <CVSROOT>.
-	If not given, git-cvsimport tries to read it from
-	`CVS/Repository`.
-
--h::
-	Print a short usage message and exit.
-
--z <fuzz>::
-	Pass the timestamp fuzz factor to cvsps, in seconds. If unset,
-	cvsps defaults to 300s.
-
--s <subst>::
-	Substitute the character "/" in branch names with <subst>
+-S <regex>::
+	Skip paths matching the regex.
 
 -a::
 	Import all commits, including recent ones. cvsimport by default
 	skips commits that have a timestamp less than 10 minutes ago.
 
--S <regex>::
-	Skip paths matching the regex.
-
 -L <limit>::
 	Limit the number of commits imported. Workaround for cases where
 	cvsimport leaks memory.
@@ -136,6 +133,9 @@ It is not recommended to use this feature if you intend to
 export changes back to CVS again later with
 gitlink:git-cvsexportcommit[1].
 
+-h::
+	Print a short usage message and exit.
+
 OUTPUT
 ------
 If '-v' is specified, the script reports what it is doing.
-- 
1.5.1
Previous: Frank LichtenheldNext: Frank Lichtenheld
Message 5 of 6 in “cvsimport: Improve documentation”
  1. 0/5 cvsimport: Improve documentationFrank Lichtenheld, Apr 6, 2007
  2. 1/5 cvsimport: sync usage lines with existing optionsFrank Lichtenheld, Apr 6, 2007
  3. 2/5 cvsimport: Improve documentation of CVSROOT and CVS module determinationFrank Lichtenheld, Apr 6, 2007
  4. 3/5 cvsimport: Improve usage error reportingFrank Lichtenheld, Apr 6, 2007
  5. 4/5 cvsimport: Reorder options in documentation for better understandingFrank Lichtenheld, Apr 6, 2007
  6. 5/5 cvsimport: Improve formating consistencyFrank Lichtenheld, Apr 6, 2007

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.