Make it possible to run git-p4 submit from within the git repository
[gitweb.git] / contrib / fast-import / git-p4.txt
index 4319c82dcd5d1da50f2f78cec578e012f020b4e7..8bf0805c74fb46b4ab26da3d61842951111df7d6 100644 (file)
@@ -51,28 +51,27 @@ Submitting
 
 git-p4 has EXPERIMENTAL support for submitting changes from a git repository
 back to a Perforce depot. This requires a Perforce checkout separate to your
-git repository. This is the basic procedure:
+git repository. All it should take is calling
 
-    cd path/to/your/perforce/checkout
-    git-p4 submit --git-dir=/path/to/your/git/repository
+    git-p4 submit
 
-This will create a temporary git branch, use git-rev-list to find out which git
-commits are in your current branch but not in the "origin" branch. You can
-override the name of the "origin" branch by using the --origin=mybranch option.
-The "origin" branch has to be the branch populated with git-p4's sync
-operation.
+in your git repository. This will attempt to locate the perforce checkout
+corresponding to your imported depot path. By default the changes between your
+current branch and the "p4" branch will be submitted. If there is no "p4"
+branch the "origin" branch will be used as reference instead. You can override
+this with the --origin=mysourcebranch option. The "origin" branch has to be the
+branch populated with git-p4's sync operation.
 
 After some preparations (which might take a while) git-p4 enters a loop where
 it will first show a Perforce submit template and a diff of the change to
-apply.  After quitting the pager with 'q' git-p4 asks for confirmation for
-issuing the "p4 submit" command and also gives you the option of editing the
-submit template using "e".
+apply in the editor. After saving and exiting the editor you will be asked whether
+you really want to submit the change or not.
 
 If a submit fails you may have to "p4 resolve" and submit manually. You can
 continue importing the remaining changes with
 
-  git-p4 submit --git-dir=/path/to/your/git/repository --continue
+  git-p4 submit --continue
 
-After submitting you should sync your origin branch from Perforce using
-git-p4's sync command.
+After submitting you should sync your perforce import branch ("p4" or "origin")
+from Perforce using git-p4's sync command.