git-p4: Cleanup; moved the (duplicated) code for turning a branch into a git ref (for example foo -> refs/remotes/p4/<project>/foo) into a separate method.

diff --git a/contrib/fast-import/git-p4.txt b/contrib/fast-import/git-p4.txt
index ff0da9d0c8339ce0c6fadda2c1f5b423627d3f1f..b16a8384bcfbfe33dc33e1076c64f5d36e75e803 100644 (file)
--- a/contrib/fast-import/git-p4.txt
+++ b/contrib/fast-import/git-p4.txt
@@ -20,9 +20,9 @@ or
 
 This will create an empty git repository in a subdirectory called "project" (or
 "myproject" with the second command), import the head revision from the
-specified perforce path into a git "p4" branch, create a master branch off it
-and check it out. If you want the entire history (not just the head revision) then
-you can simply append a "@all" to the depot path:
+specified perforce path into a git "p4" branch (remotes/p4 actually), create a
+master branch off it and check it out. If you want the entire history (not just
+the head revision) then you can simply append a "@all" to the depot path:
 
   git-p4 clone //depot/project/main@all myproject
 
@@ -36,8 +36,8 @@ If you want more control you can also use the git-p4 sync command directly:
   git-p4 sync //path/in/your/perforce/depot
 
 This will import the current head revision of the specified depot path into a
-"p4" branch of your git repository. You can use the --branch=mybranch option
-to use a different branch.
+"remotes/p4/master" branch of your git repository. You can use the
+--branch=mybranch option to use a different branch.
 
 If you want to import the entire history of a given depot path just use
 
@@ -57,12 +57,24 @@ newer changes from the Perforce depot by just calling
 
   git-p4 sync
 
-in your git repository. By default the "p4" branch is updated.
+in your git repository. By default the "remotes/p4/master" branch is updated.
 
 It is recommended to run 'git repack -a -d -f' from time to time when using
 incremental imports to optimally combine the individual git packs that each
 incremental import creates through the use of git-fast-import.
 
+
+A useful setup may be that you have a periodically updated git repository
+somewhere that contains a complete import of a Perforce project. That git
+repository can be used to clone the working repository from and one would
+import from Perforce directly after cloning using git-p4. If the connection to
+the Perforce server is slow and the working repository hasn't been synced for a
+while it may be desirable to fetch changes from the origin git repository using
+the efficient git protocol. git-p4 supports this setup by calling "git fetch origin"
+by default if there is an origin branch. You can disable this using
+
+  git config git-p4.syncFromOrigin false
+
 Updating
 ========
 
@@ -100,6 +112,13 @@ continue importing the remaining changes with
 After submitting you should sync your perforce import branch ("p4" or "origin")
 from Perforce using git-p4's sync command.
 
+If you have changes in your working directory that you haven't committed into
+git yet but that you want to commit to Perforce directly ("quick fixes") then
+you do not have to go through the intermediate step of creating a git commit
+first but you can just call
+
+  git-p4 submit --direct
+
 
 Example
 =======
@@ -136,5 +155,5 @@ Implementation Details...
   to find out which changes need to be imported.
 * git-p4 submit uses "git rev-list" to pick the commits between the "p4" branch
   and the current branch.
-  The commits themselves are applied using git diff-tree ... | patch -p1
+  The commits themselves are applied using git diff/format-patch ... | git apply