contrib/fast-import/git-p4.txt

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