4319c82dcd5d1da50f2f78cec578e012f020b4e7
   1git-p4 - Perforce <-> Git converter using git-fast-import
   2
   3Usage
   4=====
   5
   6git-p4 supports two main modes: Importing from Perforce to a Git repository is
   7done using "git-p4 sync". Submitting changes from Git back to Perforce is
   8done using "git-p4 submit".
   9
  10Importing
  11=========
  12
  13The procedure is simple:
  14
  15  mkdir repo-git
  16  cd repo-git
  17  git init
  18  git-p4 sync //path/in/your/perforce/depot
  19
  20This will import the current head revision of the specified depot path into a
  21"p4" branch of your git repository. You can use the --branch=mybranch option
  22to use a different branch.
  23
  24If you want to import the entire history of a given depot path just use
  25
  26  git-p4 sync //path/in/depot@all
  27
  28To achieve optimal compression you may want to run 'git repack -a -d -f' after
  29a big import. This may take a while.
  30
  31Support for Perforce integrations is still work in progress. Don't bother
  32trying it unless you want to hack on it :)
  33
  34
  35Incremental Imports
  36===================
  37
  38After an initial import you can easily synchronize your git repository with
  39newer changes from the Perforce depot by just calling
  40
  41  git-p4 sync
  42
  43in your git repository.
  44
  45It is recommended to run 'git repack -a -d -f' from time to time when using
  46incremental imports to optimally combine the individual git packs that each
  47incremental import creates through the use of git-fast-import.
  48
  49Submitting
  50==========
  51
  52git-p4 has EXPERIMENTAL support for submitting changes from a git repository
  53back to a Perforce depot. This requires a Perforce checkout separate to your
  54git repository. This is the basic procedure:
  55
  56    cd path/to/your/perforce/checkout
  57    git-p4 submit --git-dir=/path/to/your/git/repository
  58
  59This will create a temporary git branch, use git-rev-list to find out which git
  60commits are in your current branch but not in the "origin" branch. You can
  61override the name of the "origin" branch by using the --origin=mybranch option.
  62The "origin" branch has to be the branch populated with git-p4's sync
  63operation.
  64
  65After some preparations (which might take a while) git-p4 enters a loop where
  66it will first show a Perforce submit template and a diff of the change to
  67apply.  After quitting the pager with 'q' git-p4 asks for confirmation for
  68issuing the "p4 submit" command and also gives you the option of editing the
  69submit template using "e".
  70
  71If a submit fails you may have to "p4 resolve" and submit manually. You can
  72continue importing the remaining changes with
  73
  74  git-p4 submit --git-dir=/path/to/your/git/repository --continue
  75
  76After submitting you should sync your origin branch from Perforce using
  77git-p4's sync command.
  78