Merge branch 'master' of git://github.com/git-l10n/git-po
[git] / Documentation / git-p4.txt
1 git-p4(1)
2 =========
3
4 NAME
5 ----
6 git-p4 - Import from and submit to Perforce repositories
7
8
9 SYNOPSIS
10 --------
11 [verse]
12 'git p4 clone' [<sync options>] [<clone options>] <p4 depot path>...
13 'git p4 sync' [<sync options>] [<p4 depot path>...]
14 'git p4 rebase'
15 'git p4 submit' [<submit options>] [<master branch name>]
16
17
18 DESCRIPTION
19 -----------
20 This command provides a way to interact with p4 repositories
21 using Git.
22
23 Create a new Git repository from an existing p4 repository using
24 'git p4 clone', giving it one or more p4 depot paths.  Incorporate
25 new commits from p4 changes with 'git p4 sync'.  The 'sync' command
26 is also used to include new branches from other p4 depot paths.
27 Submit Git changes back to p4 using 'git p4 submit'.  The command
28 'git p4 rebase' does a sync plus rebases the current branch onto
29 the updated p4 remote branch.
30
31
32 EXAMPLE
33 -------
34 * Clone a repository:
35 +
36 ------------
37 $ git p4 clone //depot/path/project
38 ------------
39
40 * Do some work in the newly created Git repository:
41 +
42 ------------
43 $ cd project
44 $ vi foo.h
45 $ git commit -a -m "edited foo.h"
46 ------------
47
48 * Update the Git repository with recent changes from p4, rebasing your
49   work on top:
50 +
51 ------------
52 $ git p4 rebase
53 ------------
54
55 * Submit your commits back to p4:
56 +
57 ------------
58 $ git p4 submit
59 ------------
60
61
62 COMMANDS
63 --------
64
65 Clone
66 ~~~~~
67 Generally, 'git p4 clone' is used to create a new Git directory
68 from an existing p4 repository:
69 ------------
70 $ git p4 clone //depot/path/project
71 ------------
72 This:
73
74 1.   Creates an empty Git repository in a subdirectory called 'project'.
75 +
76 2.   Imports the full contents of the head revision from the given p4
77 depot path into a single commit in the Git branch 'refs/remotes/p4/master'.
78 +
79 3.   Creates a local branch, 'master' from this remote and checks it out.
80
81 To reproduce the entire p4 history in Git, use the '@all' modifier on
82 the depot path:
83 ------------
84 $ git p4 clone //depot/path/project@all
85 ------------
86
87
88 Sync
89 ~~~~
90 As development continues in the p4 repository, those changes can
91 be included in the Git repository using:
92 ------------
93 $ git p4 sync
94 ------------
95 This command finds new changes in p4 and imports them as Git commits.
96
97 P4 repositories can be added to an existing Git repository using
98 'git p4 sync' too:
99 ------------
100 $ mkdir repo-git
101 $ cd repo-git
102 $ git init
103 $ git p4 sync //path/in/your/perforce/depot
104 ------------
105 This imports the specified depot into
106 'refs/remotes/p4/master' in an existing Git repository.  The
107 `--branch` option can be used to specify a different branch to
108 be used for the p4 content.
109
110 If a Git repository includes branches 'refs/remotes/origin/p4', these
111 will be fetched and consulted first during a 'git p4 sync'.  Since
112 importing directly from p4 is considerably slower than pulling changes
113 from a Git remote, this can be useful in a multi-developer environment.
114
115 If there are multiple branches, doing 'git p4 sync' will automatically
116 use the "BRANCH DETECTION" algorithm to try to partition new changes
117 into the right branch.  This can be overridden with the `--branch`
118 option to specify just a single branch to update.
119
120
121 Rebase
122 ~~~~~~
123 A common working pattern is to fetch the latest changes from the p4 depot
124 and merge them with local uncommitted changes.  Often, the p4 repository
125 is the ultimate location for all code, thus a rebase workflow makes
126 sense.  This command does 'git p4 sync' followed by 'git rebase' to move
127 local commits on top of updated p4 changes.
128 ------------
129 $ git p4 rebase
130 ------------
131
132
133 Submit
134 ~~~~~~
135 Submitting changes from a Git repository back to the p4 repository
136 requires a separate p4 client workspace.  This should be specified
137 using the `P4CLIENT` environment variable or the Git configuration
138 variable 'git-p4.client'.  The p4 client must exist, but the client root
139 will be created and populated if it does not already exist.
140
141 To submit all changes that are in the current Git branch but not in
142 the 'p4/master' branch, use:
143 ------------
144 $ git p4 submit
145 ------------
146
147 To specify a branch other than the current one, use:
148 ------------
149 $ git p4 submit topicbranch
150 ------------
151
152 The upstream reference is generally 'refs/remotes/p4/master', but can
153 be overridden using the `--origin=` command-line option.
154
155 The p4 changes will be created as the user invoking 'git p4 submit'. The
156 `--preserve-user` option will cause ownership to be modified
157 according to the author of the Git commit.  This option requires admin
158 privileges in p4, which can be granted using 'p4 protect'.
159
160
161 OPTIONS
162 -------
163
164 General options
165 ~~~~~~~~~~~~~~~
166 All commands except clone accept these options.
167
168 --git-dir <dir>::
169         Set the `GIT_DIR` environment variable.  See linkgit:git[1].
170
171 -v::
172 --verbose::
173         Provide more progress information.
174
175 Sync options
176 ~~~~~~~~~~~~
177 These options can be used in the initial 'clone' as well as in
178 subsequent 'sync' operations.
179
180 --branch <ref>::
181         Import changes into <ref> instead of refs/remotes/p4/master.
182         If <ref> starts with refs/, it is used as is.  Otherwise, if
183         it does not start with p4/, that prefix is added.
184 +
185 By default a <ref> not starting with refs/ is treated as the
186 name of a remote-tracking branch (under refs/remotes/).  This
187 behavior can be modified using the --import-local option.
188 +
189 The default <ref> is "master".
190 +
191 This example imports a new remote "p4/proj2" into an existing
192 Git repository:
193 +
194 ----
195     $ git init
196     $ git p4 sync --branch=refs/remotes/p4/proj2 //depot/proj2
197 ----
198
199 --detect-branches::
200         Use the branch detection algorithm to find new paths in p4.  It is
201         documented below in "BRANCH DETECTION".
202
203 --changesfile <file>::
204         Import exactly the p4 change numbers listed in 'file', one per
205         line.  Normally, 'git p4' inspects the current p4 repository
206         state and detects the changes it should import.
207
208 --silent::
209         Do not print any progress information.
210
211 --detect-labels::
212         Query p4 for labels associated with the depot paths, and add
213         them as tags in Git. Limited usefulness as only imports labels
214         associated with new changelists. Deprecated.
215
216 --import-labels::
217         Import labels from p4 into Git.
218
219 --import-local::
220         By default, p4 branches are stored in 'refs/remotes/p4/',
221         where they will be treated as remote-tracking branches by
222         linkgit:git-branch[1] and other commands.  This option instead
223         puts p4 branches in 'refs/heads/p4/'.  Note that future
224         sync operations must specify `--import-local` as well so that
225         they can find the p4 branches in refs/heads.
226
227 --max-changes <n>::
228         Import at most 'n' changes, rather than the entire range of
229         changes included in the given revision specifier. A typical
230         usage would be use '@all' as the revision specifier, but then
231         to use '--max-changes 1000' to import only the last 1000
232         revisions rather than the entire revision history.
233
234 --changes-block-size <n>::
235         The internal block size to use when converting a revision
236         specifier such as '@all' into a list of specific change
237         numbers. Instead of using a single call to 'p4 changes' to
238         find the full list of changes for the conversion, there are a
239         sequence of calls to 'p4 changes -m', each of which requests
240         one block of changes of the given size. The default block size
241         is 500, which should usually be suitable.
242
243 --keep-path::
244         The mapping of file names from the p4 depot path to Git, by
245         default, involves removing the entire depot path.  With this
246         option, the full p4 depot path is retained in Git.  For example,
247         path '//depot/main/foo/bar.c', when imported from
248         '//depot/main/', becomes 'foo/bar.c'.  With `--keep-path`, the
249         Git path is instead 'depot/main/foo/bar.c'.
250
251 --use-client-spec::
252         Use a client spec to find the list of interesting files in p4.
253         See the "CLIENT SPEC" section below.
254
255 -/ <path>::
256         Exclude selected depot paths when cloning or syncing.
257
258 Clone options
259 ~~~~~~~~~~~~~
260 These options can be used in an initial 'clone', along with the 'sync'
261 options described above.
262
263 --destination <directory>::
264         Where to create the Git repository.  If not provided, the last
265         component in the p4 depot path is used to create a new
266         directory.
267
268 --bare::
269         Perform a bare clone.  See linkgit:git-clone[1].
270
271 Submit options
272 ~~~~~~~~~~~~~~
273 These options can be used to modify 'git p4 submit' behavior.
274
275 --origin <commit>::
276         Upstream location from which commits are identified to submit to
277         p4.  By default, this is the most recent p4 commit reachable
278         from `HEAD`.
279
280 -M::
281         Detect renames.  See linkgit:git-diff[1].  Renames will be
282         represented in p4 using explicit 'move' operations.  There
283         is no corresponding option to detect copies, but there are
284         variables for both moves and copies.
285
286 --preserve-user::
287         Re-author p4 changes before submitting to p4.  This option
288         requires p4 admin privileges.
289
290 --export-labels::
291         Export tags from Git as p4 labels. Tags found in Git are applied
292         to the perforce working directory.
293
294 -n::
295 --dry-run::
296         Show just what commits would be submitted to p4; do not change
297         state in Git or p4.
298
299 --prepare-p4-only::
300         Apply a commit to the p4 workspace, opening, adding and deleting
301         files in p4 as for a normal submit operation.  Do not issue the
302         final "p4 submit", but instead print a message about how to
303         submit manually or revert.  This option always stops after the
304         first (oldest) commit.  Git tags are not exported to p4.
305
306 --shelve::
307         Instead of submitting create a series of shelved changelists.
308         After creating each shelve, the relevant files are reverted/deleted.
309         If you have multiple commits pending multiple shelves will be created.
310
311 --update-shelve CHANGELIST::
312         Update an existing shelved changelist with this commit. Implies
313         --shelve.
314
315 --conflict=(ask|skip|quit)::
316         Conflicts can occur when applying a commit to p4.  When this
317         happens, the default behavior ("ask") is to prompt whether to
318         skip this commit and continue, or quit.  This option can be used
319         to bypass the prompt, causing conflicting commits to be automatically
320         skipped, or to quit trying to apply commits, without prompting.
321
322 --branch <branch>::
323         After submitting, sync this named branch instead of the default
324         p4/master.  See the "Sync options" section above for more
325         information.
326
327 Rebase options
328 ~~~~~~~~~~~~~~
329 These options can be used to modify 'git p4 rebase' behavior.
330
331 --import-labels::
332         Import p4 labels.
333
334 DEPOT PATH SYNTAX
335 -----------------
336 The p4 depot path argument to 'git p4 sync' and 'git p4 clone' can
337 be one or more space-separated p4 depot paths, with an optional
338 p4 revision specifier on the end:
339
340 "//depot/my/project"::
341     Import one commit with all files in the '#head' change under that tree.
342
343 "//depot/my/project@all"::
344     Import one commit for each change in the history of that depot path.
345
346 "//depot/my/project@1,6"::
347     Import only changes 1 through 6.
348
349 "//depot/proj1@all //depot/proj2@all"::
350     Import all changes from both named depot paths into a single
351     repository.  Only files below these directories are included.
352     There is not a subdirectory in Git for each "proj1" and "proj2".
353     You must use the `--destination` option when specifying more
354     than one depot path.  The revision specifier must be specified
355     identically on each depot path.  If there are files in the
356     depot paths with the same name, the path with the most recently
357     updated version of the file is the one that appears in Git.
358
359 See 'p4 help revisions' for the full syntax of p4 revision specifiers.
360
361
362 CLIENT SPEC
363 -----------
364 The p4 client specification is maintained with the 'p4 client' command
365 and contains among other fields, a View that specifies how the depot
366 is mapped into the client repository.  The 'clone' and 'sync' commands
367 can consult the client spec when given the `--use-client-spec` option or
368 when the useClientSpec variable is true.  After 'git p4 clone', the
369 useClientSpec variable is automatically set in the repository
370 configuration file.  This allows future 'git p4 submit' commands to
371 work properly; the submit command looks only at the variable and does
372 not have a command-line option.
373
374 The full syntax for a p4 view is documented in 'p4 help views'.  'git p4'
375 knows only a subset of the view syntax.  It understands multi-line
376 mappings, overlays with '+', exclusions with '-' and double-quotes
377 around whitespace.  Of the possible wildcards, 'git p4' only handles
378 '...', and only when it is at the end of the path.  'git p4' will complain
379 if it encounters an unhandled wildcard.
380
381 Bugs in the implementation of overlap mappings exist.  If multiple depot
382 paths map through overlays to the same location in the repository,
383 'git p4' can choose the wrong one.  This is hard to solve without
384 dedicating a client spec just for 'git p4'.
385
386 The name of the client can be given to 'git p4' in multiple ways.  The
387 variable 'git-p4.client' takes precedence if it exists.  Otherwise,
388 normal p4 mechanisms of determining the client are used:  environment
389 variable P4CLIENT, a file referenced by P4CONFIG, or the local host name.
390
391
392 BRANCH DETECTION
393 ----------------
394 P4 does not have the same concept of a branch as Git.  Instead,
395 p4 organizes its content as a directory tree, where by convention
396 different logical branches are in different locations in the tree.
397 The 'p4 branch' command is used to maintain mappings between
398 different areas in the tree, and indicate related content.  'git p4'
399 can use these mappings to determine branch relationships.
400
401 If you have a repository where all the branches of interest exist as
402 subdirectories of a single depot path, you can use `--detect-branches`
403 when cloning or syncing to have 'git p4' automatically find
404 subdirectories in p4, and to generate these as branches in Git.
405
406 For example, if the P4 repository structure is:
407 ----
408 //depot/main/...
409 //depot/branch1/...
410 ----
411
412 And "p4 branch -o branch1" shows a View line that looks like:
413 ----
414 //depot/main/... //depot/branch1/...
415 ----
416
417 Then this 'git p4 clone' command:
418 ----
419 git p4 clone --detect-branches //depot@all
420 ----
421 produces a separate branch in 'refs/remotes/p4/' for //depot/main,
422 called 'master', and one for //depot/branch1 called 'depot/branch1'.
423
424 However, it is not necessary to create branches in p4 to be able to use
425 them like branches.  Because it is difficult to infer branch
426 relationships automatically, a Git configuration setting
427 'git-p4.branchList' can be used to explicitly identify branch
428 relationships.  It is a list of "source:destination" pairs, like a
429 simple p4 branch specification, where the "source" and "destination" are
430 the path elements in the p4 repository.  The example above relied on the
431 presence of the p4 branch.  Without p4 branches, the same result will
432 occur with:
433 ----
434 git init depot
435 cd depot
436 git config git-p4.branchList main:branch1
437 git p4 clone --detect-branches //depot@all .
438 ----
439
440
441 PERFORMANCE
442 -----------
443 The fast-import mechanism used by 'git p4' creates one pack file for
444 each invocation of 'git p4 sync'.  Normally, Git garbage compression
445 (linkgit:git-gc[1]) automatically compresses these to fewer pack files,
446 but explicit invocation of 'git repack -adf' may improve performance.
447
448
449 CONFIGURATION VARIABLES
450 -----------------------
451 The following config settings can be used to modify 'git p4' behavior.
452 They all are in the 'git-p4' section.
453
454 General variables
455 ~~~~~~~~~~~~~~~~~
456 git-p4.user::
457         User specified as an option to all p4 commands, with '-u <user>'.
458         The environment variable 'P4USER' can be used instead.
459
460 git-p4.password::
461         Password specified as an option to all p4 commands, with
462         '-P <password>'.
463         The environment variable 'P4PASS' can be used instead.
464
465 git-p4.port::
466         Port specified as an option to all p4 commands, with
467         '-p <port>'.
468         The environment variable 'P4PORT' can be used instead.
469
470 git-p4.host::
471         Host specified as an option to all p4 commands, with
472         '-h <host>'.
473         The environment variable 'P4HOST' can be used instead.
474
475 git-p4.client::
476         Client specified as an option to all p4 commands, with
477         '-c <client>', including the client spec.
478
479 git-p4.retries::
480         Specifies the number of times to retry a p4 command (notably,
481         'p4 sync') if the network times out. The default value is 3.
482         Set the value to 0 to disable retries or if your p4 version
483         does not support retries (pre 2012.2).
484
485 Clone and sync variables
486 ~~~~~~~~~~~~~~~~~~~~~~~~
487 git-p4.syncFromOrigin::
488         Because importing commits from other Git repositories is much faster
489         than importing them from p4, a mechanism exists to find p4 changes
490         first in Git remotes.  If branches exist under 'refs/remote/origin/p4',
491         those will be fetched and used when syncing from p4.  This
492         variable can be set to 'false' to disable this behavior.
493
494 git-p4.branchUser::
495         One phase in branch detection involves looking at p4 branches
496         to find new ones to import.  By default, all branches are
497         inspected.  This option limits the search to just those owned
498         by the single user named in the variable.
499
500 git-p4.branchList::
501         List of branches to be imported when branch detection is
502         enabled.  Each entry should be a pair of branch names separated
503         by a colon (:).  This example declares that both branchA and
504         branchB were created from main:
505 +
506 -------------
507 git config       git-p4.branchList main:branchA
508 git config --add git-p4.branchList main:branchB
509 -------------
510
511 git-p4.ignoredP4Labels::
512         List of p4 labels to ignore. This is built automatically as
513         unimportable labels are discovered.
514
515 git-p4.importLabels::
516         Import p4 labels into git, as per --import-labels.
517
518 git-p4.labelImportRegexp::
519         Only p4 labels matching this regular expression will be imported. The
520         default value is '[a-zA-Z0-9_\-.]+$'.
521
522 git-p4.useClientSpec::
523         Specify that the p4 client spec should be used to identify p4
524         depot paths of interest.  This is equivalent to specifying the
525         option `--use-client-spec`.  See the "CLIENT SPEC" section above.
526         This variable is a boolean, not the name of a p4 client.
527
528 git-p4.pathEncoding::
529         Perforce keeps the encoding of a path as given by the originating OS.
530         Git expects paths encoded as UTF-8. Use this config to tell git-p4
531         what encoding Perforce had used for the paths. This encoding is used
532         to transcode the paths to UTF-8. As an example, Perforce on Windows
533         often uses "cp1252" to encode path names.
534
535 git-p4.largeFileSystem::
536         Specify the system that is used for large (binary) files. Please note
537         that large file systems do not support the 'git p4 submit' command.
538         Only Git LFS is implemented right now (see https://git-lfs.github.com/
539         for more information). Download and install the Git LFS command line
540         extension to use this option and configure it like this:
541 +
542 -------------
543 git config       git-p4.largeFileSystem GitLFS
544 -------------
545
546 git-p4.largeFileExtensions::
547         All files matching a file extension in the list will be processed
548         by the large file system. Do not prefix the extensions with '.'.
549
550 git-p4.largeFileThreshold::
551         All files with an uncompressed size exceeding the threshold will be
552         processed by the large file system. By default the threshold is
553         defined in bytes. Add the suffix k, m, or g to change the unit.
554
555 git-p4.largeFileCompressedThreshold::
556         All files with a compressed size exceeding the threshold will be
557         processed by the large file system. This option might slow down
558         your clone/sync process. By default the threshold is defined in
559         bytes. Add the suffix k, m, or g to change the unit.
560
561 git-p4.largeFilePush::
562         Boolean variable which defines if large files are automatically
563         pushed to a server.
564
565 git-p4.keepEmptyCommits::
566         A changelist that contains only excluded files will be imported
567         as an empty commit if this boolean option is set to true.
568
569 git-p4.mapUser::
570         Map a P4 user to a name and email address in Git. Use a string
571         with the following format to create a mapping:
572 +
573 -------------
574 git config --add git-p4.mapUser "p4user = First Last <mail@address.com>"
575 -------------
576 +
577 A mapping will override any user information from P4. Mappings for
578 multiple P4 user can be defined.
579
580 Submit variables
581 ~~~~~~~~~~~~~~~~
582 git-p4.detectRenames::
583         Detect renames.  See linkgit:git-diff[1].  This can be true,
584         false, or a score as expected by 'git diff -M'.
585
586 git-p4.detectCopies::
587         Detect copies.  See linkgit:git-diff[1].  This can be true,
588         false, or a score as expected by 'git diff -C'.
589
590 git-p4.detectCopiesHarder::
591         Detect copies harder.  See linkgit:git-diff[1].  A boolean.
592
593 git-p4.preserveUser::
594         On submit, re-author changes to reflect the Git author,
595         regardless of who invokes 'git p4 submit'.
596
597 git-p4.allowMissingP4Users::
598         When 'preserveUser' is true, 'git p4' normally dies if it
599         cannot find an author in the p4 user map.  This setting
600         submits the change regardless.
601
602 git-p4.skipSubmitEdit::
603         The submit process invokes the editor before each p4 change
604         is submitted.  If this setting is true, though, the editing
605         step is skipped.
606
607 git-p4.skipSubmitEditCheck::
608         After editing the p4 change message, 'git p4' makes sure that
609         the description really was changed by looking at the file
610         modification time.  This option disables that test.
611
612 git-p4.allowSubmit::
613         By default, any branch can be used as the source for a 'git p4
614         submit' operation.  This configuration variable, if set, permits only
615         the named branches to be used as submit sources.  Branch names
616         must be the short names (no "refs/heads/"), and should be
617         separated by commas (","), with no spaces.
618
619 git-p4.skipUserNameCheck::
620         If the user running 'git p4 submit' does not exist in the p4
621         user map, 'git p4' exits.  This option can be used to force
622         submission regardless.
623
624 git-p4.attemptRCSCleanup::
625         If enabled, 'git p4 submit' will attempt to cleanup RCS keywords
626         ($Header$, etc). These would otherwise cause merge conflicts and prevent
627         the submit going ahead. This option should be considered experimental at
628         present.
629
630 git-p4.exportLabels::
631         Export Git tags to p4 labels, as per --export-labels.
632
633 git-p4.labelExportRegexp::
634         Only p4 labels matching this regular expression will be exported. The
635         default value is '[a-zA-Z0-9_\-.]+$'.
636
637 git-p4.conflict::
638         Specify submit behavior when a conflict with p4 is found, as per
639         --conflict.  The default behavior is 'ask'.
640
641 IMPLEMENTATION DETAILS
642 ----------------------
643 * Changesets from p4 are imported using Git fast-import.
644 * Cloning or syncing does not require a p4 client; file contents are
645   collected using 'p4 print'.
646 * Submitting requires a p4 client, which is not in the same location
647   as the Git repository.  Patches are applied, one at a time, to
648   this p4 client and submitted from there.
649 * Each commit imported by 'git p4' has a line at the end of the log
650   message indicating the p4 depot location and change number.  This
651   line is used by later 'git p4 sync' operations to know which p4
652   changes are new.