Improve documentation and comments regarding directory traversal API

diff --git a/Documentation/git-p4.txt b/Documentation/git-p4.txt
index 612d51d4e76537724442a492fe4232540b18b6d0..fe1f49bc6f26950987bc5520267663f4f335dab0 100644 (file)
--- a/Documentation/git-p4.txt
+++ b/Documentation/git-p4.txt
@@ -158,11 +158,14 @@ OPTIONS
 
 General options
 ~~~~~~~~~~~~~~~
-All commands except clone accept this option.
+All commands except clone accept these options.
 
 --git-dir <dir>::
        Set the 'GIT_DIR' environment variable.  See linkgit:git[1].
 
+--verbose::
+       Provide more progress information.
+
 Sync options
 ~~~~~~~~~~~~
 These options can be used in the initial 'clone' as well as in
@@ -176,6 +179,7 @@ subsequent 'sync' operations.
 +
 This example imports a new remote "p4/proj2" into an existing
 git repository:
++
 ----
     $ git init
     $ git p4 sync --branch=refs/remotes/p4/proj2 //depot/proj2
@@ -193,9 +197,6 @@ git repository:
 --silent::
        Do not print any progress information.
 
---verbose::
-       Provide more progress information.
-
 --detect-labels::
        Query p4 for labels associated with the depot paths, and add
        them as tags in git. Limited usefulness as only imports labels
@@ -249,9 +250,6 @@ Submit options
 ~~~~~~~~~~~~~~
 These options can be used to modify 'git p4 submit' behavior.
 
---verbose::
-       Provide more progress information.
-
 --origin <commit>::
        Upstream location from which commits are identified to submit to
        p4.  By default, this is the most recent p4 commit reachable
@@ -267,7 +265,7 @@ These options can be used to modify 'git p4 submit' behavior.
        Re-author p4 changes before submitting to p4.  This option
        requires p4 admin privileges.
 
---export-labels:
+--export-labels::
        Export tags from git as p4 labels. Tags found in git are applied
        to the perforce working directory.
 
@@ -441,6 +439,11 @@ git-p4.branchList::
        enabled.  Each entry should be a pair of branch names separated
        by a colon (:).  This example declares that both branchA and
        branchB were created from main:
++
+-------------
+git config       git-p4.branchList main:branchA
+git config --add git-p4.branchList main:branchB
+-------------
 
 git-p4.ignoredP4Labels::
        List of p4 labels to ignore. This is built automatically as
@@ -449,14 +452,9 @@ git-p4.ignoredP4Labels::
 git-p4.importLabels::
        Import p4 labels into git, as per --import-labels.
 
-git-p4.validLabelRegexp::
+git-p4.labelImportRegexp::
        Only p4 labels matching this regular expression will be imported. The
-       default value is '[A-Z0-9_\-.]+$'.
-
--------------
-git config       git-p4.branchList main:branchA
-git config --add git-p4.branchList main:branchB
--------------
+       default value is '[a-zA-Z0-9_\-.]+$'.
 
 git-p4.useClientSpec::
        Specify that the p4 client spec should be used to identify p4
@@ -506,7 +504,7 @@ git-p4.skipUserNameCheck::
        user map, 'git p4' exits.  This option can be used to force
        submission regardless.
 
-git-p4.attemptRCSCleanup:
+git-p4.attemptRCSCleanup::
        If enabled, 'git p4 submit' will attempt to cleanup RCS keywords
        ($Header$, etc). These would otherwise cause merge conflicts and prevent
        the submit going ahead. This option should be considered experimental at
@@ -515,9 +513,9 @@ git-p4.attemptRCSCleanup:
 git-p4.exportLabels::
        Export git tags to p4 labels, as per --export-labels.
 
-git-p4.validLabelRegexp::
+git-p4.labelExportRegexp::
        Only p4 labels matching this regular expression will be exported. The
-       default value is '[A-Z0-9_\-.]+$'.
+       default value is '[a-zA-Z0-9_\-.]+$'.
 
 IMPLEMENTATION DETAILS
 ----------------------