documentation: fix alphabetic ordered list for git-rebase man page

[git.git] / Documentation / git-p4.txt

diff --git a/Documentation/git-p4.txt b/Documentation/git-p4.txt
index 9305e099874b259d3aa3ebfd6c7f2a47b73948fc..ed827902fc540d098fc548e5bb68ab3ab95ffa25 100644 (file)
--- a/Documentation/git-p4.txt
+++ b/Documentation/git-p4.txt
@@ -211,7 +211,9 @@ git repository:
        By default, p4 branches are stored in 'refs/remotes/p4/',
        where they will be treated as remote-tracking branches by
        linkgit:git-branch[1] and other commands.  This option instead
-       puts p4 branches in 'refs/heads/p4/'.
+       puts p4 branches in 'refs/heads/p4/'.  Note that future
+       sync operations must specify '--import-local' as well so that
+       they can find the p4 branches in refs/heads.
 
 --max-changes <n>::
        Limit the number of imported changes to 'n'.  Useful to
@@ -228,9 +230,7 @@ git repository:
 
 --use-client-spec::
        Use a client spec to find the list of interesting files in p4.
-       The client spec is discovered using 'p4 client -o' which checks
-       the 'P4CLIENT' environment variable and returns a mapping of
-       depot files to workspace files.
+       See the "CLIENT SPEC" section below.
 
 Clone options
 ~~~~~~~~~~~~~
@@ -262,7 +262,9 @@ These options can be used to modify 'git p4 submit' behavior.
 
 -M[<n>]::
        Detect renames.  See linkgit:git-diff[1].  Renames will be
-       represented in p4 using explicit 'move' operations.
+       represented in p4 using explicit 'move' operations.  There
+       is no corresponding option to detect copies, but there are
+       variables for both moves and copies.
 
 --preserve-user::
        Re-author p4 changes before submitting to p4.  This option
@@ -297,6 +299,31 @@ p4 revision specifier on the end:
 See 'p4 help revisions' for the full syntax of p4 revision specifiers.
 
 
+CLIENT SPEC
+-----------
+The p4 client specification is maintained with the 'p4 client' command
+and contains among other fields, a View that specifies how the depot
+is mapped into the client repository.  The 'clone' and 'sync' commands
+can consult the client spec when given the '--use-client-spec' option or
+when the useClientSpec variable is true.  After 'git p4 clone', the
+useClientSpec variable is automatically set in the repository
+configuration file.  This allows future 'git p4 submit' commands to
+work properly; the submit command looks only at the variable and does
+not have a command-line option.
+
+The full syntax for a p4 view is documented in 'p4 help views'.  Git-p4
+knows only a subset of the view syntax.  It understands multi-line
+mappings, overlays with '+', exclusions with '-' and double-quotes
+around whitespace.  Of the possible wildcards, git-p4 only handles
+'...', and only when it is at the end of the path.  Git-p4 will complain
+if it encounters an unhandled wildcard.
+
+The name of the client can be given to git-p4 in multiple ways.  The
+variable 'git-p4.client' takes precedence if it exists.  Otherwise,
+normal p4 mechanisms of determining the client are used:  environment
+variable P4CLIENT, a file referenced by P4CONFIG, or the local host name.
+
+
 BRANCH DETECTION
 ----------------
 P4 does not have the same concept of a branch as git.  Instead,
@@ -380,9 +407,7 @@ git-p4.host::
 
 git-p4.client::
        Client specified as an option to all p4 commands, with
-       '-c <client>'.  This can also be used as a way to find
-       the client spec for the 'useClientSpec' option.
-       The environment variable 'P4CLIENT' can be used instead.
+       '-c <client>', including the client spec.
 
 Clone and sync variables
 ~~~~~~~~~~~~~~~~~~~~~~~~
@@ -410,10 +435,10 @@ git config --add git-p4.branchList main:branchB
 -------------
 
 git-p4.useClientSpec::
-       Specify that the p4 client spec to be used to identify p4 depot
-       paths of interest.  This is equivalent to specifying the option
-       '--use-client-spec'.  The variable 'git-p4.client' can be used
-       to specify the name of the client.
+       Specify that the p4 client spec should be used to identify p4
+       depot paths of interest.  This is equivalent to specifying the
+       option '--use-client-spec'.  See the "CLIENT SPEC" section above.
+       This variable is a boolean, not the name of a p4 client.
 
 Submit variables
 ~~~~~~~~~~~~~~~~
@@ -448,7 +473,9 @@ git-p4.skipSubmitEditCheck::
 git-p4.allowSubmit::
        By default, any branch can be used as the source for a 'git p4
        submit' operation.  This configuration variable, if set, permits only
-       the named branches to be used as submit sources.
+       the named branches to be used as submit sources.  Branch names
+       must be the short names (no "refs/heads/"), and should be
+       separated by commas (","), with no spaces.
 
 git-p4.skipUserNameCheck::
        If the user running 'git p4 submit' does not exist in the p4