]> git.ipfire.org Git - thirdparty/git.git/blame - Documentation/git-p4.txt
Start the 2.46 cycle
[thirdparty/git.git] / Documentation / git-p4.txt
CommitLineData
6679c34c
PW
1git-p4(1)
2=========
3
4NAME
5----
6git-p4 - Import from and submit to Perforce repositories
7
8
9SYNOPSIS
10--------
11[verse]
133db54d
JNA
12'git p4 clone' [<sync-options>] [<clone-options>] <p4-depot-path>...
13'git p4 sync' [<sync-options>] [<p4-depot-path>...]
6679c34c 14'git p4 rebase'
133db54d 15'git p4 submit' [<submit-options>] [<master-branch-name>]
6679c34c
PW
16
17
18DESCRIPTION
19-----------
20This command provides a way to interact with p4 repositories
2de9b711 21using Git.
6679c34c 22
2de9b711 23Create a new Git repository from an existing p4 repository using
6679c34c
PW
24'git p4 clone', giving it one or more p4 depot paths. Incorporate
25new commits from p4 changes with 'git p4 sync'. The 'sync' command
26is also used to include new branches from other p4 depot paths.
2de9b711 27Submit Git changes back to p4 using 'git p4 submit'. The command
6679c34c
PW
28'git p4 rebase' does a sync plus rebases the current branch onto
29the updated p4 remote branch.
30
31
76a8788c
NTND
32EXAMPLES
33--------
6679c34c
PW
34* Clone a repository:
35+
36------------
37$ git p4 clone //depot/path/project
38------------
39
2de9b711 40* Do some work in the newly created Git repository:
6679c34c
PW
41+
42------------
43$ cd project
44$ vi foo.h
45$ git commit -a -m "edited foo.h"
46------------
47
2de9b711 48* Update the Git repository with recent changes from p4, rebasing your
6679c34c
PW
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
62COMMANDS
63--------
64
65Clone
66~~~~~
2de9b711 67Generally, 'git p4 clone' is used to create a new Git directory
6679c34c
PW
68from an existing p4 repository:
69------------
70$ git p4 clone //depot/path/project
71------------
72This:
73
ba170517 741. Creates an empty Git repository in a subdirectory called 'project'.
6679c34c 75+
ba170517
JNA
762. 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'.
6679c34c 78+
ba170517 793. Creates a local branch, 'master' from this remote and checks it out.
6679c34c 80
2de9b711 81To reproduce the entire p4 history in Git, use the '@all' modifier on
6679c34c
PW
82the depot path:
83------------
84$ git p4 clone //depot/path/project@all
85------------
86
87
88Sync
89~~~~
90As development continues in the p4 repository, those changes can
2de9b711 91be included in the Git repository using:
6679c34c
PW
92------------
93$ git p4 sync
94------------
2de9b711 95This command finds new changes in p4 and imports them as Git commits.
6679c34c 96
2de9b711 97P4 repositories can be added to an existing Git repository using
6679c34c
PW
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------------
105This imports the specified depot into
2de9b711 106'refs/remotes/p4/master' in an existing Git repository. The
bcf9626a 107`--branch` option can be used to specify a different branch to
6679c34c
PW
108be used for the p4 content.
109
2de9b711 110If a Git repository includes branches 'refs/remotes/origin/p4', these
6679c34c
PW
111will be fetched and consulted first during a 'git p4 sync'. Since
112importing directly from p4 is considerably slower than pulling changes
2de9b711 113from a Git remote, this can be useful in a multi-developer environment.
6679c34c 114
8c9e8b6e
PW
115If there are multiple branches, doing 'git p4 sync' will automatically
116use the "BRANCH DETECTION" algorithm to try to partition new changes
bcf9626a 117into the right branch. This can be overridden with the `--branch`
8c9e8b6e
PW
118option to specify just a single branch to update.
119
6679c34c
PW
120
121Rebase
122~~~~~~
123A common working pattern is to fetch the latest changes from the p4 depot
124and merge them with local uncommitted changes. Often, the p4 repository
125is the ultimate location for all code, thus a rebase workflow makes
126sense. This command does 'git p4 sync' followed by 'git rebase' to move
127local commits on top of updated p4 changes.
128------------
129$ git p4 rebase
130------------
131
132
133Submit
134~~~~~~
2de9b711 135Submitting changes from a Git repository back to the p4 repository
6679c34c 136requires a separate p4 client workspace. This should be specified
47d81b5c 137using the `P4CLIENT` environment variable or the Git configuration
6679c34c
PW
138variable 'git-p4.client'. The p4 client must exist, but the client root
139will be created and populated if it does not already exist.
140
2de9b711 141To submit all changes that are in the current Git branch but not in
6679c34c
PW
142the 'p4/master' branch, use:
143------------
144$ git p4 submit
145------------
146
147To specify a branch other than the current one, use:
148------------
149$ git p4 submit topicbranch
150------------
151
f55b87c1
RM
152To specify a single commit or a range of commits, use:
153------------
154$ git p4 submit --commit <sha1>
155$ git p4 submit --commit <sha1..sha1>
156------------
157
6679c34c 158The upstream reference is generally 'refs/remotes/p4/master', but can
bcf9626a 159be overridden using the `--origin=` command-line option.
6679c34c
PW
160
161The p4 changes will be created as the user invoking 'git p4 submit'. The
bcf9626a 162`--preserve-user` option will cause ownership to be modified
2de9b711 163according to the author of the Git commit. This option requires admin
6679c34c
PW
164privileges in p4, which can be granted using 'p4 protect'.
165
8cf422db
LD
166To shelve changes instead of submitting, use `--shelve` and `--update-shelve`:
167
168----
169$ git p4 submit --shelve
170$ git p4 submit --update-shelve 1234 --update-shelve 2345
171----
6679c34c 172
123f6317
LD
173
174Unshelve
175~~~~~~~~
176Unshelving will take a shelved P4 changelist, and produce the equivalent git commit
08813127 177in the branch refs/remotes/p4-unshelved/<changelist>.
123f6317
LD
178
179The git commit is created relative to the current origin revision (HEAD by default).
89143ac2
LD
180A parent commit is created based on the origin, and then the unshelve commit is
181created based on that.
123f6317
LD
182
183The origin revision can be changed with the "--origin" option.
184
08813127 185If the target branch in refs/remotes/p4-unshelved already exists, the old one will
123f6317
LD
186be renamed.
187
188----
189$ git p4 sync
190$ git p4 unshelve 12345
08813127 191$ git show p4-unshelved/12345
123f6317
LD
192<submit more changes via p4 to the same files>
193$ git p4 unshelve 12345
194<refuses to unshelve until git is in sync with p4 again>
195
196----
197
6679c34c
PW
198OPTIONS
199-------
200
201General options
202~~~~~~~~~~~~~~~
6a10b6aa 203All commands except clone accept these options.
6679c34c
PW
204
205--git-dir <dir>::
eee7f4a2 206 Set the `GIT_DIR` environment variable. See linkgit:git[1].
6679c34c 207
f84cb684
PW
208-v::
209--verbose::
6a10b6aa
LD
210 Provide more progress information.
211
6679c34c
PW
212Sync options
213~~~~~~~~~~~~
214These options can be used in the initial 'clone' as well as in
215subsequent 'sync' operations.
216
d6ac1d21
MS
217--branch <ref>::
218 Import changes into <ref> instead of refs/remotes/p4/master.
219 If <ref> starts with refs/, it is used as is. Otherwise, if
220 it does not start with p4/, that prefix is added.
221+
222By default a <ref> not starting with refs/ is treated as the
223name of a remote-tracking branch (under refs/remotes/). This
224behavior can be modified using the --import-local option.
225+
226The default <ref> is "master".
1471c6b1
PW
227+
228This example imports a new remote "p4/proj2" into an existing
2de9b711 229Git repository:
41925d58 230+
1471c6b1
PW
231----
232 $ git init
233 $ git p4 sync --branch=refs/remotes/p4/proj2 //depot/proj2
234----
6679c34c
PW
235
236--detect-branches::
237 Use the branch detection algorithm to find new paths in p4. It is
238 documented below in "BRANCH DETECTION".
239
240--changesfile <file>::
241 Import exactly the p4 change numbers listed in 'file', one per
242 line. Normally, 'git p4' inspects the current p4 repository
243 state and detects the changes it should import.
244
245--silent::
246 Do not print any progress information.
247
6679c34c
PW
248--detect-labels::
249 Query p4 for labels associated with the depot paths, and add
2de9b711 250 them as tags in Git. Limited usefulness as only imports labels
06804c76
LD
251 associated with new changelists. Deprecated.
252
253--import-labels::
2de9b711 254 Import labels from p4 into Git.
6679c34c
PW
255
256--import-local::
257 By default, p4 branches are stored in 'refs/remotes/p4/',
258 where they will be treated as remote-tracking branches by
259 linkgit:git-branch[1] and other commands. This option instead
5a92a6ce 260 puts p4 branches in 'refs/heads/p4/'. Note that future
bcf9626a 261 sync operations must specify `--import-local` as well so that
5a92a6ce 262 they can find the p4 branches in refs/heads.
6679c34c
PW
263
264--max-changes <n>::
96b2d54a
LS
265 Import at most 'n' changes, rather than the entire range of
266 changes included in the given revision specifier. A typical
267 usage would be use '@all' as the revision specifier, but then
268 to use '--max-changes 1000' to import only the last 1000
269 revisions rather than the entire revision history.
270
271--changes-block-size <n>::
272 The internal block size to use when converting a revision
273 specifier such as '@all' into a list of specific change
274 numbers. Instead of using a single call to 'p4 changes' to
275 find the full list of changes for the conversion, there are a
276 sequence of calls to 'p4 changes -m', each of which requests
277 one block of changes of the given size. The default block size
278 is 500, which should usually be suitable.
6679c34c
PW
279
280--keep-path::
2de9b711 281 The mapping of file names from the p4 depot path to Git, by
6679c34c 282 default, involves removing the entire depot path. With this
2de9b711 283 option, the full p4 depot path is retained in Git. For example,
6679c34c 284 path '//depot/main/foo/bar.c', when imported from
bcf9626a 285 '//depot/main/', becomes 'foo/bar.c'. With `--keep-path`, the
2de9b711 286 Git path is instead 'depot/main/foo/bar.c'.
6679c34c
PW
287
288--use-client-spec::
289 Use a client spec to find the list of interesting files in p4.
896a6816 290 See the "CLIENT SPEC" section below.
6679c34c 291
51334bb0
LD
292-/ <path>::
293 Exclude selected depot paths when cloning or syncing.
294
6679c34c
PW
295Clone options
296~~~~~~~~~~~~~
297These options can be used in an initial 'clone', along with the 'sync'
298options described above.
299
300--destination <directory>::
2de9b711 301 Where to create the Git repository. If not provided, the last
6679c34c
PW
302 component in the p4 depot path is used to create a new
303 directory.
304
305--bare::
306 Perform a bare clone. See linkgit:git-clone[1].
307
6679c34c
PW
308Submit options
309~~~~~~~~~~~~~~
310These options can be used to modify 'git p4 submit' behavior.
311
6679c34c
PW
312--origin <commit>::
313 Upstream location from which commits are identified to submit to
314 p4. By default, this is the most recent p4 commit reachable
661c3e9b 315 from `HEAD`.
6679c34c 316
84cb0003 317-M::
6679c34c 318 Detect renames. See linkgit:git-diff[1]. Renames will be
28755dba
PW
319 represented in p4 using explicit 'move' operations. There
320 is no corresponding option to detect copies, but there are
321 variables for both moves and copies.
6679c34c
PW
322
323--preserve-user::
324 Re-author p4 changes before submitting to p4. This option
325 requires p4 admin privileges.
326
c8942a22 327--export-labels::
2de9b711 328 Export tags from Git as p4 labels. Tags found in Git are applied
06804c76
LD
329 to the perforce working directory.
330
f84cb684
PW
331-n::
332--dry-run::
ef739f08 333 Show just what commits would be submitted to p4; do not change
2de9b711 334 state in Git or p4.
ef739f08 335
728b7ad8
PW
336--prepare-p4-only::
337 Apply a commit to the p4 workspace, opening, adding and deleting
338 files in p4 as for a normal submit operation. Do not issue the
339 final "p4 submit", but instead print a message about how to
340 submit manually or revert. This option always stops after the
341 first (oldest) commit. Git tags are not exported to p4.
342
b34fa577
VK
343--shelve::
344 Instead of submitting create a series of shelved changelists.
345 After creating each shelve, the relevant files are reverted/deleted.
346 If you have multiple commits pending multiple shelves will be created.
347
46c609e9
LD
348--update-shelve CHANGELIST::
349 Update an existing shelved changelist with this commit. Implies
8cf422db 350 --shelve. Repeat for multiple shelved changelists.
46c609e9 351
6bbfd137
PW
352--conflict=(ask|skip|quit)::
353 Conflicts can occur when applying a commit to p4. When this
354 happens, the default behavior ("ask") is to prompt whether to
355 skip this commit and continue, or quit. This option can be used
356 to bypass the prompt, causing conflicting commits to be automatically
357 skipped, or to quit trying to apply commits, without prompting.
358
44e8d26c
PW
359--branch <branch>::
360 After submitting, sync this named branch instead of the default
361 p4/master. See the "Sync options" section above for more
362 information.
363
06ebae09 364--commit (<sha1>|<sha1>..<sha1>)::
f55b87c1
RM
365 Submit only the specified commit or range of commits, instead of the full
366 list of changes that are in the current Git branch.
367
368--disable-rebase::
369 Disable the automatic rebase after all commits have been successfully
3b3477ea 370 submitted. Can also be set with git-p4.disableRebase.
f55b87c1 371
b9d34db9
LD
372--disable-p4sync::
373 Disable the automatic sync of p4/master from Perforce after commits have
374 been submitted. Implies --disable-rebase. Can also be set with
375 git-p4.disableP4Sync. Sync with origin/master still goes ahead if possible.
376
4935c458
BK
377Hooks for submit
378----------------
379
380p4-pre-submit
381~~~~~~~~~~~~~
382
251c8c50
CB
383The `p4-pre-submit` hook is executed if it exists and is executable.
384The hook takes no parameters and nothing from standard input. Exiting with
385non-zero status from this script prevents `git-p4 submit` from launching.
4935c458 386It can be bypassed with the `--no-verify` command line option.
251c8c50
CB
387
388One usage scenario is to run unit tests in the hook.
389
38ecf752
BK
390p4-prepare-changelist
391~~~~~~~~~~~~~~~~~~~~~
392
393The `p4-prepare-changelist` hook is executed right after preparing
394the default changelist message and before the editor is started.
395It takes one parameter, the name of the file that contains the
396changelist text. Exiting with a non-zero status from the script
397will abort the process.
398
399The purpose of the hook is to edit the message file in place,
7efc3782 400and it is not suppressed by the `--no-verify` option. This hook
38ecf752
BK
401is called even if `--prepare-p4-only` is set.
402
403p4-changelist
404~~~~~~~~~~~~~
405
406The `p4-changelist` hook is executed after the changelist
407message has been edited by the user. It can be bypassed with the
408`--no-verify` option. It takes a single parameter, the name
409of the file that holds the proposed changelist text. Exiting
410with a non-zero status causes the command to abort.
411
412The hook is allowed to edit the changelist file and can be used
413to normalize the text into some project standard format. It can
414also be used to refuse the Submit after inspect the message file.
415
416p4-post-changelist
417~~~~~~~~~~~~~~~~~~
418
419The `p4-post-changelist` hook is invoked after the submit has
b7e20b43 420successfully occurred in P4. It takes no parameters and is meant
38ecf752
BK
421primarily for notification and cannot affect the outcome of the
422git p4 submit action.
423
424
4935c458 425
06804c76
LD
426Rebase options
427~~~~~~~~~~~~~~
428These options can be used to modify 'git p4 rebase' behavior.
429
430--import-labels::
431 Import p4 labels.
6679c34c 432
123f6317
LD
433Unshelve options
434~~~~~~~~~~~~~~~~
435
436--origin::
437 Sets the git refspec against which the shelved P4 changelist is compared.
438 Defaults to p4/master.
439
6679c34c
PW
440DEPOT PATH SYNTAX
441-----------------
442The p4 depot path argument to 'git p4 sync' and 'git p4 clone' can
443be one or more space-separated p4 depot paths, with an optional
444p4 revision specifier on the end:
445
446"//depot/my/project"::
447 Import one commit with all files in the '#head' change under that tree.
448
449"//depot/my/project@all"::
450 Import one commit for each change in the history of that depot path.
451
452"//depot/my/project@1,6"::
453 Import only changes 1 through 6.
454
da191d15
PW
455"//depot/proj1@all //depot/proj2@all"::
456 Import all changes from both named depot paths into a single
457 repository. Only files below these directories are included.
2de9b711 458 There is not a subdirectory in Git for each "proj1" and "proj2".
bcf9626a 459 You must use the `--destination` option when specifying more
da191d15
PW
460 than one depot path. The revision specifier must be specified
461 identically on each depot path. If there are files in the
462 depot paths with the same name, the path with the most recently
2de9b711 463 updated version of the file is the one that appears in Git.
6679c34c
PW
464
465See 'p4 help revisions' for the full syntax of p4 revision specifiers.
466
467
896a6816
PW
468CLIENT SPEC
469-----------
470The p4 client specification is maintained with the 'p4 client' command
471and contains among other fields, a View that specifies how the depot
a93d33ee 472is mapped into the client repository. The 'clone' and 'sync' commands
bcf9626a 473can consult the client spec when given the `--use-client-spec` option or
a93d33ee
PW
474when the useClientSpec variable is true. After 'git p4 clone', the
475useClientSpec variable is automatically set in the repository
476configuration file. This allows future 'git p4 submit' commands to
477work properly; the submit command looks only at the variable and does
478not have a command-line option.
896a6816 479
2de9b711 480The full syntax for a p4 view is documented in 'p4 help views'. 'git p4'
896a6816
PW
481knows only a subset of the view syntax. It understands multi-line
482mappings, overlays with '+', exclusions with '-' and double-quotes
b6f93057 483around whitespace. Of the possible wildcards, 'git p4' only handles
2de9b711 484'...', and only when it is at the end of the path. 'git p4' will complain
896a6816
PW
485if it encounters an unhandled wildcard.
486
42d8c279
PW
487Bugs in the implementation of overlap mappings exist. If multiple depot
488paths map through overlays to the same location in the repository,
b6f93057
PW
489'git p4' can choose the wrong one. This is hard to solve without
490dedicating a client spec just for 'git p4'.
42d8c279 491
b6f93057 492The name of the client can be given to 'git p4' in multiple ways. The
896a6816
PW
493variable 'git-p4.client' takes precedence if it exists. Otherwise,
494normal p4 mechanisms of determining the client are used: environment
f156a093 495variable `P4CLIENT`, a file referenced by `P4CONFIG`, or the local host name.
896a6816
PW
496
497
6679c34c
PW
498BRANCH DETECTION
499----------------
2de9b711 500P4 does not have the same concept of a branch as Git. Instead,
6679c34c
PW
501p4 organizes its content as a directory tree, where by convention
502different logical branches are in different locations in the tree.
503The 'p4 branch' command is used to maintain mappings between
504different areas in the tree, and indicate related content. 'git p4'
505can use these mappings to determine branch relationships.
506
507If you have a repository where all the branches of interest exist as
bcf9626a 508subdirectories of a single depot path, you can use `--detect-branches`
6679c34c 509when cloning or syncing to have 'git p4' automatically find
2de9b711 510subdirectories in p4, and to generate these as branches in Git.
6679c34c
PW
511
512For example, if the P4 repository structure is:
513----
514//depot/main/...
515//depot/branch1/...
516----
517
518And "p4 branch -o branch1" shows a View line that looks like:
519----
520//depot/main/... //depot/branch1/...
521----
522
523Then this 'git p4 clone' command:
524----
525git p4 clone --detect-branches //depot@all
526----
527produces a separate branch in 'refs/remotes/p4/' for //depot/main,
528called 'master', and one for //depot/branch1 called 'depot/branch1'.
529
530However, it is not necessary to create branches in p4 to be able to use
531them like branches. Because it is difficult to infer branch
2de9b711 532relationships automatically, a Git configuration setting
6679c34c
PW
533'git-p4.branchList' can be used to explicitly identify branch
534relationships. It is a list of "source:destination" pairs, like a
535simple p4 branch specification, where the "source" and "destination" are
536the path elements in the p4 repository. The example above relied on the
537presence of the p4 branch. Without p4 branches, the same result will
538occur with:
539----
182edef5
PW
540git init depot
541cd depot
6679c34c 542git config git-p4.branchList main:branch1
182edef5 543git p4 clone --detect-branches //depot@all .
6679c34c
PW
544----
545
546
547PERFORMANCE
548-----------
549The fast-import mechanism used by 'git p4' creates one pack file for
2de9b711 550each invocation of 'git p4 sync'. Normally, Git garbage compression
6679c34c
PW
551(linkgit:git-gc[1]) automatically compresses these to fewer pack files,
552but explicit invocation of 'git repack -adf' may improve performance.
553
554
555CONFIGURATION VARIABLES
556-----------------------
557The following config settings can be used to modify 'git p4' behavior.
558They all are in the 'git-p4' section.
559
560General variables
561~~~~~~~~~~~~~~~~~
562git-p4.user::
563 User specified as an option to all p4 commands, with '-u <user>'.
f156a093 564 The environment variable `P4USER` can be used instead.
6679c34c
PW
565
566git-p4.password::
567 Password specified as an option to all p4 commands, with
568 '-P <password>'.
f156a093 569 The environment variable `P4PASS` can be used instead.
6679c34c
PW
570
571git-p4.port::
572 Port specified as an option to all p4 commands, with
573 '-p <port>'.
f156a093 574 The environment variable `P4PORT` can be used instead.
6679c34c
PW
575
576git-p4.host::
577 Host specified as an option to all p4 commands, with
578 '-h <host>'.
f156a093 579 The environment variable `P4HOST` can be used instead.
6679c34c
PW
580
581git-p4.client::
582 Client specified as an option to all p4 commands, with
896a6816 583 '-c <client>', including the client spec.
6679c34c 584
89a6ecc5
LS
585git-p4.retries::
586 Specifies the number of times to retry a p4 command (notably,
587 'p4 sync') if the network times out. The default value is 3.
bc233524
IK
588 Set the value to 0 to disable retries or if your p4 version
589 does not support retries (pre 2012.2).
89a6ecc5 590
6679c34c
PW
591Clone and sync variables
592~~~~~~~~~~~~~~~~~~~~~~~~
593git-p4.syncFromOrigin::
2de9b711 594 Because importing commits from other Git repositories is much faster
6679c34c 595 than importing them from p4, a mechanism exists to find p4 changes
2de9b711 596 first in Git remotes. If branches exist under 'refs/remote/origin/p4',
6679c34c
PW
597 those will be fetched and used when syncing from p4. This
598 variable can be set to 'false' to disable this behavior.
599
600git-p4.branchUser::
601 One phase in branch detection involves looking at p4 branches
602 to find new ones to import. By default, all branches are
603 inspected. This option limits the search to just those owned
604 by the single user named in the variable.
605
606git-p4.branchList::
607 List of branches to be imported when branch detection is
608 enabled. Each entry should be a pair of branch names separated
609 by a colon (:). This example declares that both branchA and
610 branchB were created from main:
41925d58 611+
c8942a22
LD
612-------------
613git config git-p4.branchList main:branchA
614git config --add git-p4.branchList main:branchB
615-------------
616
06804c76
LD
617git-p4.ignoredP4Labels::
618 List of p4 labels to ignore. This is built automatically as
619 unimportable labels are discovered.
620
621git-p4.importLabels::
622 Import p4 labels into git, as per --import-labels.
623
c8942a22 624git-p4.labelImportRegexp::
06804c76 625 Only p4 labels matching this regular expression will be imported. The
c8942a22 626 default value is '[a-zA-Z0-9_\-.]+$'.
6679c34c
PW
627
628git-p4.useClientSpec::
896a6816
PW
629 Specify that the p4 client spec should be used to identify p4
630 depot paths of interest. This is equivalent to specifying the
bcf9626a 631 option `--use-client-spec`. See the "CLIENT SPEC" section above.
896a6816 632 This variable is a boolean, not the name of a p4 client.
6679c34c 633
a9e38359
LS
634git-p4.pathEncoding::
635 Perforce keeps the encoding of a path as given by the originating OS.
636 Git expects paths encoded as UTF-8. Use this config to tell git-p4
637 what encoding Perforce had used for the paths. This encoding is used
638 to transcode the paths to UTF-8. As an example, Perforce on Windows
f7b5ff60
TK
639 often uses "cp1252" to encode path names. If this option is passed
640 into a p4 clone request, it is persisted in the resulting new git
641 repo.
642
643git-p4.metadataDecodingStrategy::
644 Perforce keeps the encoding of a changelist descriptions and user
645 full names as stored by the client on a given OS. The p4v client
646 uses the OS-local encoding, and so different users can end up storing
647 different changelist descriptions or user full names in different
648 encodings, in the same depot.
649 Git tolerates inconsistent/incorrect encodings in commit messages
650 and author names, but expects them to be specified in utf-8.
651 git-p4 can use three different decoding strategies in handling the
652 encoding uncertainty in Perforce: 'passthrough' simply passes the
653 original bytes through from Perforce to git, creating usable but
654 incorrectly-encoded data when the Perforce data is encoded as
655 anything other than utf-8. 'strict' expects the Perforce data to be
656 encoded as utf-8, and fails to import when this is not true.
657 'fallback' attempts to interpret the data as utf-8, and otherwise
658 falls back to using a secondary encoding - by default the common
659 windows encoding 'cp-1252' - with upper-range bytes escaped if
660 decoding with the fallback encoding also fails.
661 Under python2 the default strategy is 'passthrough' for historical
662 reasons, and under python3 the default is 'fallback'.
663 When 'strict' is selected and decoding fails, the error message will
664 propose changing this config parameter as a workaround. If this
665 option is passed into a p4 clone request, it is persisted into the
666 resulting new git repo.
667
668git-p4.metadataFallbackEncoding::
669 Specify the fallback encoding to use when decoding Perforce author
670 names and changelists descriptions using the 'fallback' strategy
671 (see git-p4.metadataDecodingStrategy). The fallback encoding will
672 only be used when decoding as utf-8 fails. This option defaults to
673 cp1252, a common windows encoding. If this option is passed into a
674 p4 clone request, it is persisted into the resulting new git repo.
a9e38359 675
a5db4b12
LS
676git-p4.largeFileSystem::
677 Specify the system that is used for large (binary) files. Please note
678 that large file systems do not support the 'git p4 submit' command.
887523eb
LS
679 Only Git LFS is implemented right now (see https://git-lfs.github.com/
680 for more information). Download and install the Git LFS command line
681 extension to use this option and configure it like this:
a5db4b12
LS
682+
683-------------
684git config git-p4.largeFileSystem GitLFS
685-------------
a5db4b12
LS
686
687git-p4.largeFileExtensions::
688 All files matching a file extension in the list will be processed
689 by the large file system. Do not prefix the extensions with '.'.
690
691git-p4.largeFileThreshold::
692 All files with an uncompressed size exceeding the threshold will be
693 processed by the large file system. By default the threshold is
694 defined in bytes. Add the suffix k, m, or g to change the unit.
695
696git-p4.largeFileCompressedThreshold::
697 All files with a compressed size exceeding the threshold will be
698 processed by the large file system. This option might slow down
699 your clone/sync process. By default the threshold is defined in
700 bytes. Add the suffix k, m, or g to change the unit.
701
702git-p4.largeFilePush::
703 Boolean variable which defines if large files are automatically
704 pushed to a server.
705
4ae048e6
LS
706git-p4.keepEmptyCommits::
707 A changelist that contains only excluded files will be imported
708 as an empty commit if this boolean option is set to true.
709
10d08a14
LS
710git-p4.mapUser::
711 Map a P4 user to a name and email address in Git. Use a string
712 with the following format to create a mapping:
713+
714-------------
715git config --add git-p4.mapUser "p4user = First Last <mail@address.com>"
716-------------
717+
718A mapping will override any user information from P4. Mappings for
719multiple P4 user can be defined.
720
6679c34c
PW
721Submit variables
722~~~~~~~~~~~~~~~~
723git-p4.detectRenames::
84cb0003
GG
724 Detect renames. See linkgit:git-diff[1]. This can be true,
725 false, or a score as expected by 'git diff -M'.
6679c34c
PW
726
727git-p4.detectCopies::
84cb0003
GG
728 Detect copies. See linkgit:git-diff[1]. This can be true,
729 false, or a score as expected by 'git diff -C'.
6679c34c
PW
730
731git-p4.detectCopiesHarder::
84cb0003 732 Detect copies harder. See linkgit:git-diff[1]. A boolean.
6679c34c
PW
733
734git-p4.preserveUser::
2de9b711 735 On submit, re-author changes to reflect the Git author,
6679c34c
PW
736 regardless of who invokes 'git p4 submit'.
737
738git-p4.allowMissingP4Users::
739 When 'preserveUser' is true, 'git p4' normally dies if it
740 cannot find an author in the p4 user map. This setting
741 submits the change regardless.
742
743git-p4.skipSubmitEdit::
744 The submit process invokes the editor before each p4 change
745 is submitted. If this setting is true, though, the editing
746 step is skipped.
747
748git-p4.skipSubmitEditCheck::
749 After editing the p4 change message, 'git p4' makes sure that
750 the description really was changed by looking at the file
751 modification time. This option disables that test.
752
753git-p4.allowSubmit::
754 By default, any branch can be used as the source for a 'git p4
755 submit' operation. This configuration variable, if set, permits only
28755dba
PW
756 the named branches to be used as submit sources. Branch names
757 must be the short names (no "refs/heads/"), and should be
758 separated by commas (","), with no spaces.
6679c34c
PW
759
760git-p4.skipUserNameCheck::
761 If the user running 'git p4 submit' does not exist in the p4
762 user map, 'git p4' exits. This option can be used to force
763 submission regardless.
764
41925d58 765git-p4.attemptRCSCleanup::
06804c76
LD
766 If enabled, 'git p4 submit' will attempt to cleanup RCS keywords
767 ($Header$, etc). These would otherwise cause merge conflicts and prevent
768 the submit going ahead. This option should be considered experimental at
769 present.
770
771git-p4.exportLabels::
2de9b711 772 Export Git tags to p4 labels, as per --export-labels.
06804c76 773
c8942a22 774git-p4.labelExportRegexp::
06804c76 775 Only p4 labels matching this regular expression will be exported. The
c8942a22 776 default value is '[a-zA-Z0-9_\-.]+$'.
6679c34c 777
6bbfd137
PW
778git-p4.conflict::
779 Specify submit behavior when a conflict with p4 is found, as per
780 --conflict. The default behavior is 'ask'.
781
3b3477ea
LD
782git-p4.disableRebase::
783 Do not rebase the tree against p4/master following a submit.
784
b9d34db9
LD
785git-p4.disableP4Sync::
786 Do not sync p4/master with Perforce following a submit. Implies git-p4.disableRebase.
787
6679c34c
PW
788IMPLEMENTATION DETAILS
789----------------------
2de9b711 790* Changesets from p4 are imported using Git fast-import.
6679c34c
PW
791* Cloning or syncing does not require a p4 client; file contents are
792 collected using 'p4 print'.
793* Submitting requires a p4 client, which is not in the same location
2de9b711 794 as the Git repository. Patches are applied, one at a time, to
6679c34c
PW
795 this p4 client and submitted from there.
796* Each commit imported by 'git p4' has a line at the end of the log
797 message indicating the p4 depot location and change number. This
798 line is used by later 'git p4 sync' operations to know which p4
799 changes are new.
cafd9828
ÆAB
800
801GIT
802---
803Part of the linkgit:git[1] suite