Provide some information for single branch imports where the commits go
[gitweb.git] / contrib / fast-import / git-p4.txt
index ff0da9d0c8339ce0c6fadda2c1f5b423627d3f1f..c315158d8d7eb110b927c920f0fe348ff612054f 100644 (file)
@@ -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
 
@@ -63,6 +63,18 @@ 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