Merge branch 'rd/p4-doc-markup-env'
authorJunio C Hamano <gitster@pobox.com>
Mon, 4 Jun 2018 12:39:49 +0000 (21:39 +0900)
committerJunio C Hamano <gitster@pobox.com>
Mon, 4 Jun 2018 12:39:49 +0000 (21:39 +0900)
Doc markup update.

* rd/p4-doc-markup-env:
p4.txt: Use backquotes for variable names

1  2 
Documentation/git-p4.txt
diff --combined Documentation/git-p4.txt
index 6646d5e6cc1cc1ebceba98d1c984e6a6fe9b2602,a10d2529f75a1991ba25117245ece51cb52f9544..b9fecebc0cdd8e1306fa33c9426867f0caefd867
@@@ -29,8 -29,8 +29,8 @@@ Submit Git changes back to p4 using 'gi
  the updated p4 remote branch.
  
  
 -EXAMPLE
 --------
 +EXAMPLES
 +--------
  * Clone a repository:
  +
  ------------
@@@ -164,31 -164,6 +164,31 @@@ $ git p4 submit --shelv
  $ git p4 submit --update-shelve 1234 --update-shelve 2345
  ----
  
 +
 +Unshelve
 +~~~~~~~~
 +Unshelving will take a shelved P4 changelist, and produce the equivalent git commit
 +in the branch refs/remotes/p4/unshelved/<changelist>.
 +
 +The git commit is created relative to the current origin revision (HEAD by default).
 +If the shelved changelist's parent revisions differ, git-p4 will refuse to unshelve;
 +you need to be unshelving onto an equivalent tree.
 +
 +The origin revision can be changed with the "--origin" option.
 +
 +If the target branch in refs/remotes/p4/unshelved already exists, the old one will
 +be renamed.
 +
 +----
 +$ git p4 sync
 +$ git p4 unshelve 12345
 +$ git show refs/remotes/p4/unshelved/12345
 +<submit more changes via p4 to the same files>
 +$ git p4 unshelve 12345
 +<refuses to unshelve until git is in sync with p4 again>
 +
 +----
 +
  OPTIONS
  -------
  
@@@ -362,13 -337,6 +362,13 @@@ These options can be used to modify 'gi
  --import-labels::
        Import p4 labels.
  
 +Unshelve options
 +~~~~~~~~~~~~~~~~
 +
 +--origin::
 +    Sets the git refspec against which the shelved P4 changelist is compared.
 +    Defaults to p4/master.
 +
  DEPOT PATH SYNTAX
  -----------------
  The p4 depot path argument to 'git p4 sync' and 'git p4 clone' can
@@@ -424,7 -392,7 +424,7 @@@ dedicating a client spec just for 'git 
  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.
+ variable `P4CLIENT`, a file referenced by `P4CONFIG`, or the local host name.
  
  
  BRANCH DETECTION
@@@ -493,22 -461,22 +493,22 @@@ General variable
  ~~~~~~~~~~~~~~~~~
  git-p4.user::
        User specified as an option to all p4 commands, with '-u <user>'.
-       The environment variable 'P4USER' can be used instead.
+       The environment variable `P4USER` can be used instead.
  
  git-p4.password::
        Password specified as an option to all p4 commands, with
        '-P <password>'.
-       The environment variable 'P4PASS' can be used instead.
+       The environment variable `P4PASS` can be used instead.
  
  git-p4.port::
        Port specified as an option to all p4 commands, with
        '-p <port>'.
-       The environment variable 'P4PORT' can be used instead.
+       The environment variable `P4PORT` can be used instead.
  
  git-p4.host::
        Host specified as an option to all p4 commands, with
        '-h <host>'.
-       The environment variable 'P4HOST' can be used instead.
+       The environment variable `P4HOST` can be used instead.
  
  git-p4.client::
        Client specified as an option to all p4 commands, with