Fix "compilation" :)
[fast-export/barak.git] / git-p4.txt
blob30e2cb9a559bec3c6a31157a51581426ae412ad1
1 git-p4 - Perforce <-> Git converter using git-fast-import
3 Usage
4 =====
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".
10 Importing
11 =========
13 The procedure is simple:
15   mkdir repo-git
16   cd repo-git
17   git init
18   git-p4 sync //path/in/your/perforce/depot
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.
24 If you want to import the entire history of a given depot path just use
26   git-p4 sync //path/in/depot@all
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.
31 Support for Perforce integrations is still work in progress. Don't bother
32 trying it unless you want to hack on it :)
35 Incremental Imports
36 ===================
38 After an initial import you can easily synchronize your git repository with
39 newer changes from the Perforce depot by just calling
41   git-p4 sync
43 in your git repository.
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.
49 Submitting
50 ==========
52 git-p4 has support for submitting changes from a git repository back to the
53 Perforce depot. This requires a Perforce checkout separate to your git
54 repository. To submit all changes that are in the current git branch but not in
55 the "p4" branch (or "origin" if "p4" doesn't exist) simply call
57     git-p4 submit
59 in your git repository. If you want to submit changes in a specific branch that
60 is not your current git branch you can also pass that as an argument:
62     git-p4 submit mytopicbranch
64 You can override the reference branch with the --origin=mysourcebranch option.
66 If a submit fails you may have to "p4 resolve" and submit manually. You can
67 continue importing the remaining changes with
69   git-p4 submit --continue
71 After submitting you should sync your perforce import branch ("p4" or "origin")
72 from Perforce using git-p4's sync command.