contrib / fast-import / git-p4.txton commit Make it possible to invoke git-p4 from within subdirectories of a git working tree. (2061865)
   1git-p4.py - 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.py sync". Submitting changes from Git back to Perforce is
   8done using "git-p4.py submit".
   9
  10Importing
  11=========
  12
  13The procedure is simple:
  14
  15  mkdir repo-git
  16  cd repo-git
  17  git init
  18  git-p4.py sync //path/in/your/perforce/depot
  19
  20This will import the current head revision of the specified depot path into the
  21master branch of your git repository. You can use the --branch=mybranch option
  22to let git-p4 import from Perforce into a git branch of your choice.
  23
  24If you want to import the entire history of a given depot path just use
  25
  26  git-p4.py 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.p4 sync
  42
  43in your git repository. git-p4 stores the depot path of the original import in
  44the .git/config file and remembers the last imported p4 revision as a git tag
  45called p4/<changenum> .
  46
  47It is recommended to run 'git repack -a -d -f' from time to time when using
  48incremental imports to optimally combine the individual git packs that each
  49incremental import creates through the use of git-fast-import.
  50
  51Submitting
  52==========
  53
  54git-p4 has EXPERIMENTAL support for submitting changes from a git repository
  55back to a Perforce depot. This requires a Perforce checkout separate to your
  56git repository. This is the basic procedure:
  57
  58    cd path/to/your/perforce/checkout
  59    git-p4.py submit --git-dir=/path/to/your/git/repository
  60
  61This will create a temporary git branch, use git-rev-list to find out which git
  62commits are in your current branch but not in the "origin" branch. You can
  63override the name of the "origin" branch by using the --origin=mybranch option.
  64The "origin" branch has to be the branch populated with git-p4's sync
  65operation.
  66
  67After some preparations (which might take a while) git-p4 enters a loop where
  68it will first show a Perforce submit template and a diff of the change to
  69apply.  After quitting the pager with 'q' git-p4 asks for confirmation for
  70issuing the "p4 submit" command and also gives you the option of editing the
  71submit template using "e".
  72
  73If a submit fails you may have to "p4 resolve" and submit manually. You can
  74continue importing the remaining changes with
  75
  76  git-p4.py submit --git-dir=/path/to/your/git/repository --continue
  77
  78After submitting you should sync your origin branch from Perforce using
  79git-p4's sync command.
  80