git-p4: add option to disable syncing of p4/master with p4
[git/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]
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
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
32EXAMPLE
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
2de9b711 741. Creates an empty Git repository in a subdirectory called 'project'.
6679c34c
PW
75+
762. Imports the full contents of the head revision from the given p4
2de9b711 77depot path into a single commit in the Git branch 'refs/remotes/p4/master'.
6679c34c
PW
78+
793. Creates a local branch, 'master' from this remote and checks it out.
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
PW
172
173OPTIONS
174-------
175
176General options
177~~~~~~~~~~~~~~~
6a10b6aa 178All commands except clone accept these options.
6679c34c
PW
179
180--git-dir <dir>::
eee7f4a2 181 Set the `GIT_DIR` environment variable. See linkgit:git[1].
6679c34c 182
f84cb684
PW
183-v::
184--verbose::
6a10b6aa
LD
185 Provide more progress information.
186
6679c34c
PW
187Sync options
188~~~~~~~~~~~~
189These options can be used in the initial 'clone' as well as in
190subsequent 'sync' operations.
191
d6ac1d21
MS
192--branch <ref>::
193 Import changes into <ref> instead of refs/remotes/p4/master.
194 If <ref> starts with refs/, it is used as is. Otherwise, if
195 it does not start with p4/, that prefix is added.
196+
197By default a <ref> not starting with refs/ is treated as the
198name of a remote-tracking branch (under refs/remotes/). This
199behavior can be modified using the --import-local option.
200+
201The default <ref> is "master".
1471c6b1
PW
202+
203This example imports a new remote "p4/proj2" into an existing
2de9b711 204Git repository:
41925d58 205+
1471c6b1
PW
206----
207 $ git init
208 $ git p4 sync --branch=refs/remotes/p4/proj2 //depot/proj2
209----
6679c34c
PW
210
211--detect-branches::
212 Use the branch detection algorithm to find new paths in p4. It is
213 documented below in "BRANCH DETECTION".
214
215--changesfile <file>::
216 Import exactly the p4 change numbers listed in 'file', one per
217 line. Normally, 'git p4' inspects the current p4 repository
218 state and detects the changes it should import.
219
220--silent::
221 Do not print any progress information.
222
6679c34c
PW
223--detect-labels::
224 Query p4 for labels associated with the depot paths, and add
2de9b711 225 them as tags in Git. Limited usefulness as only imports labels
06804c76
LD
226 associated with new changelists. Deprecated.
227
228--import-labels::
2de9b711 229 Import labels from p4 into Git.
6679c34c
PW
230
231--import-local::
232 By default, p4 branches are stored in 'refs/remotes/p4/',
233 where they will be treated as remote-tracking branches by
234 linkgit:git-branch[1] and other commands. This option instead
5a92a6ce 235 puts p4 branches in 'refs/heads/p4/'. Note that future
bcf9626a 236 sync operations must specify `--import-local` as well so that
5a92a6ce 237 they can find the p4 branches in refs/heads.
6679c34c
PW
238
239--max-changes <n>::
96b2d54a
LS
240 Import at most 'n' changes, rather than the entire range of
241 changes included in the given revision specifier. A typical
242 usage would be use '@all' as the revision specifier, but then
243 to use '--max-changes 1000' to import only the last 1000
244 revisions rather than the entire revision history.
245
246--changes-block-size <n>::
247 The internal block size to use when converting a revision
248 specifier such as '@all' into a list of specific change
249 numbers. Instead of using a single call to 'p4 changes' to
250 find the full list of changes for the conversion, there are a
251 sequence of calls to 'p4 changes -m', each of which requests
252 one block of changes of the given size. The default block size
253 is 500, which should usually be suitable.
6679c34c
PW
254
255--keep-path::
2de9b711 256 The mapping of file names from the p4 depot path to Git, by
6679c34c 257 default, involves removing the entire depot path. With this
2de9b711 258 option, the full p4 depot path is retained in Git. For example,
6679c34c 259 path '//depot/main/foo/bar.c', when imported from
bcf9626a 260 '//depot/main/', becomes 'foo/bar.c'. With `--keep-path`, the
2de9b711 261 Git path is instead 'depot/main/foo/bar.c'.
6679c34c
PW
262
263--use-client-spec::
264 Use a client spec to find the list of interesting files in p4.
896a6816 265 See the "CLIENT SPEC" section below.
6679c34c 266
51334bb0
LD
267-/ <path>::
268 Exclude selected depot paths when cloning or syncing.
269
6679c34c
PW
270Clone options
271~~~~~~~~~~~~~
272These options can be used in an initial 'clone', along with the 'sync'
273options described above.
274
275--destination <directory>::
2de9b711 276 Where to create the Git repository. If not provided, the last
6679c34c
PW
277 component in the p4 depot path is used to create a new
278 directory.
279
280--bare::
281 Perform a bare clone. See linkgit:git-clone[1].
282
6679c34c
PW
283Submit options
284~~~~~~~~~~~~~~
285These options can be used to modify 'git p4 submit' behavior.
286
6679c34c
PW
287--origin <commit>::
288 Upstream location from which commits are identified to submit to
289 p4. By default, this is the most recent p4 commit reachable
661c3e9b 290 from `HEAD`.
6679c34c 291
84cb0003 292-M::
6679c34c 293 Detect renames. See linkgit:git-diff[1]. Renames will be
28755dba
PW
294 represented in p4 using explicit 'move' operations. There
295 is no corresponding option to detect copies, but there are
296 variables for both moves and copies.
6679c34c
PW
297
298--preserve-user::
299 Re-author p4 changes before submitting to p4. This option
300 requires p4 admin privileges.
301
c8942a22 302--export-labels::
2de9b711 303 Export tags from Git as p4 labels. Tags found in Git are applied
06804c76
LD
304 to the perforce working directory.
305
f84cb684
PW
306-n::
307--dry-run::
ef739f08 308 Show just what commits would be submitted to p4; do not change
2de9b711 309 state in Git or p4.
ef739f08 310
728b7ad8
PW
311--prepare-p4-only::
312 Apply a commit to the p4 workspace, opening, adding and deleting
313 files in p4 as for a normal submit operation. Do not issue the
314 final "p4 submit", but instead print a message about how to
315 submit manually or revert. This option always stops after the
316 first (oldest) commit. Git tags are not exported to p4.
317
b34fa577
VK
318--shelve::
319 Instead of submitting create a series of shelved changelists.
320 After creating each shelve, the relevant files are reverted/deleted.
321 If you have multiple commits pending multiple shelves will be created.
322
46c609e9
LD
323--update-shelve CHANGELIST::
324 Update an existing shelved changelist with this commit. Implies
8cf422db 325 --shelve. Repeat for multiple shelved changelists.
46c609e9 326
6bbfd137
PW
327--conflict=(ask|skip|quit)::
328 Conflicts can occur when applying a commit to p4. When this
329 happens, the default behavior ("ask") is to prompt whether to
330 skip this commit and continue, or quit. This option can be used
331 to bypass the prompt, causing conflicting commits to be automatically
332 skipped, or to quit trying to apply commits, without prompting.
333
44e8d26c
PW
334--branch <branch>::
335 After submitting, sync this named branch instead of the default
336 p4/master. See the "Sync options" section above for more
337 information.
338
f55b87c1
RM
339--commit <sha1>|<sha1..sha1>::
340 Submit only the specified commit or range of commits, instead of the full
341 list of changes that are in the current Git branch.
342
343--disable-rebase::
344 Disable the automatic rebase after all commits have been successfully
3b3477ea 345 submitted. Can also be set with git-p4.disableRebase.
f55b87c1 346
b9d34db9
LD
347--disable-p4sync::
348 Disable the automatic sync of p4/master from Perforce after commits have
349 been submitted. Implies --disable-rebase. Can also be set with
350 git-p4.disableP4Sync. Sync with origin/master still goes ahead if possible.
351
06804c76
LD
352Rebase options
353~~~~~~~~~~~~~~
354These options can be used to modify 'git p4 rebase' behavior.
355
356--import-labels::
357 Import p4 labels.
6679c34c
PW
358
359DEPOT PATH SYNTAX
360-----------------
361The p4 depot path argument to 'git p4 sync' and 'git p4 clone' can
362be one or more space-separated p4 depot paths, with an optional
363p4 revision specifier on the end:
364
365"//depot/my/project"::
366 Import one commit with all files in the '#head' change under that tree.
367
368"//depot/my/project@all"::
369 Import one commit for each change in the history of that depot path.
370
371"//depot/my/project@1,6"::
372 Import only changes 1 through 6.
373
da191d15
PW
374"//depot/proj1@all //depot/proj2@all"::
375 Import all changes from both named depot paths into a single
376 repository. Only files below these directories are included.
2de9b711 377 There is not a subdirectory in Git for each "proj1" and "proj2".
bcf9626a 378 You must use the `--destination` option when specifying more
da191d15
PW
379 than one depot path. The revision specifier must be specified
380 identically on each depot path. If there are files in the
381 depot paths with the same name, the path with the most recently
2de9b711 382 updated version of the file is the one that appears in Git.
6679c34c
PW
383
384See 'p4 help revisions' for the full syntax of p4 revision specifiers.
385
386
896a6816
PW
387CLIENT SPEC
388-----------
389The p4 client specification is maintained with the 'p4 client' command
390and contains among other fields, a View that specifies how the depot
a93d33ee 391is mapped into the client repository. The 'clone' and 'sync' commands
bcf9626a 392can consult the client spec when given the `--use-client-spec` option or
a93d33ee
PW
393when the useClientSpec variable is true. After 'git p4 clone', the
394useClientSpec variable is automatically set in the repository
395configuration file. This allows future 'git p4 submit' commands to
396work properly; the submit command looks only at the variable and does
397not have a command-line option.
896a6816 398
2de9b711 399The full syntax for a p4 view is documented in 'p4 help views'. 'git p4'
896a6816
PW
400knows only a subset of the view syntax. It understands multi-line
401mappings, overlays with '+', exclusions with '-' and double-quotes
b6f93057 402around whitespace. Of the possible wildcards, 'git p4' only handles
2de9b711 403'...', and only when it is at the end of the path. 'git p4' will complain
896a6816
PW
404if it encounters an unhandled wildcard.
405
42d8c279
PW
406Bugs in the implementation of overlap mappings exist. If multiple depot
407paths map through overlays to the same location in the repository,
b6f93057
PW
408'git p4' can choose the wrong one. This is hard to solve without
409dedicating a client spec just for 'git p4'.
42d8c279 410
b6f93057 411The name of the client can be given to 'git p4' in multiple ways. The
896a6816
PW
412variable 'git-p4.client' takes precedence if it exists. Otherwise,
413normal p4 mechanisms of determining the client are used: environment
414variable P4CLIENT, a file referenced by P4CONFIG, or the local host name.
415
416
6679c34c
PW
417BRANCH DETECTION
418----------------
2de9b711 419P4 does not have the same concept of a branch as Git. Instead,
6679c34c
PW
420p4 organizes its content as a directory tree, where by convention
421different logical branches are in different locations in the tree.
422The 'p4 branch' command is used to maintain mappings between
423different areas in the tree, and indicate related content. 'git p4'
424can use these mappings to determine branch relationships.
425
426If you have a repository where all the branches of interest exist as
bcf9626a 427subdirectories of a single depot path, you can use `--detect-branches`
6679c34c 428when cloning or syncing to have 'git p4' automatically find
2de9b711 429subdirectories in p4, and to generate these as branches in Git.
6679c34c
PW
430
431For example, if the P4 repository structure is:
432----
433//depot/main/...
434//depot/branch1/...
435----
436
437And "p4 branch -o branch1" shows a View line that looks like:
438----
439//depot/main/... //depot/branch1/...
440----
441
442Then this 'git p4 clone' command:
443----
444git p4 clone --detect-branches //depot@all
445----
446produces a separate branch in 'refs/remotes/p4/' for //depot/main,
447called 'master', and one for //depot/branch1 called 'depot/branch1'.
448
449However, it is not necessary to create branches in p4 to be able to use
450them like branches. Because it is difficult to infer branch
2de9b711 451relationships automatically, a Git configuration setting
6679c34c
PW
452'git-p4.branchList' can be used to explicitly identify branch
453relationships. It is a list of "source:destination" pairs, like a
454simple p4 branch specification, where the "source" and "destination" are
455the path elements in the p4 repository. The example above relied on the
456presence of the p4 branch. Without p4 branches, the same result will
457occur with:
458----
182edef5
PW
459git init depot
460cd depot
6679c34c 461git config git-p4.branchList main:branch1
182edef5 462git p4 clone --detect-branches //depot@all .
6679c34c
PW
463----
464
465
466PERFORMANCE
467-----------
468The fast-import mechanism used by 'git p4' creates one pack file for
2de9b711 469each invocation of 'git p4 sync'. Normally, Git garbage compression
6679c34c
PW
470(linkgit:git-gc[1]) automatically compresses these to fewer pack files,
471but explicit invocation of 'git repack -adf' may improve performance.
472
473
474CONFIGURATION VARIABLES
475-----------------------
476The following config settings can be used to modify 'git p4' behavior.
477They all are in the 'git-p4' section.
478
479General variables
480~~~~~~~~~~~~~~~~~
481git-p4.user::
482 User specified as an option to all p4 commands, with '-u <user>'.
483 The environment variable 'P4USER' can be used instead.
484
485git-p4.password::
486 Password specified as an option to all p4 commands, with
487 '-P <password>'.
488 The environment variable 'P4PASS' can be used instead.
489
490git-p4.port::
491 Port specified as an option to all p4 commands, with
492 '-p <port>'.
493 The environment variable 'P4PORT' can be used instead.
494
495git-p4.host::
496 Host specified as an option to all p4 commands, with
497 '-h <host>'.
498 The environment variable 'P4HOST' can be used instead.
499
500git-p4.client::
501 Client specified as an option to all p4 commands, with
896a6816 502 '-c <client>', including the client spec.
6679c34c 503
89a6ecc5
LS
504git-p4.retries::
505 Specifies the number of times to retry a p4 command (notably,
506 'p4 sync') if the network times out. The default value is 3.
bc233524
IK
507 Set the value to 0 to disable retries or if your p4 version
508 does not support retries (pre 2012.2).
89a6ecc5 509
6679c34c
PW
510Clone and sync variables
511~~~~~~~~~~~~~~~~~~~~~~~~
512git-p4.syncFromOrigin::
2de9b711 513 Because importing commits from other Git repositories is much faster
6679c34c 514 than importing them from p4, a mechanism exists to find p4 changes
2de9b711 515 first in Git remotes. If branches exist under 'refs/remote/origin/p4',
6679c34c
PW
516 those will be fetched and used when syncing from p4. This
517 variable can be set to 'false' to disable this behavior.
518
519git-p4.branchUser::
520 One phase in branch detection involves looking at p4 branches
521 to find new ones to import. By default, all branches are
522 inspected. This option limits the search to just those owned
523 by the single user named in the variable.
524
525git-p4.branchList::
526 List of branches to be imported when branch detection is
527 enabled. Each entry should be a pair of branch names separated
528 by a colon (:). This example declares that both branchA and
529 branchB were created from main:
41925d58 530+
c8942a22
LD
531-------------
532git config git-p4.branchList main:branchA
533git config --add git-p4.branchList main:branchB
534-------------
535
06804c76
LD
536git-p4.ignoredP4Labels::
537 List of p4 labels to ignore. This is built automatically as
538 unimportable labels are discovered.
539
540git-p4.importLabels::
541 Import p4 labels into git, as per --import-labels.
542
c8942a22 543git-p4.labelImportRegexp::
06804c76 544 Only p4 labels matching this regular expression will be imported. The
c8942a22 545 default value is '[a-zA-Z0-9_\-.]+$'.
6679c34c
PW
546
547git-p4.useClientSpec::
896a6816
PW
548 Specify that the p4 client spec should be used to identify p4
549 depot paths of interest. This is equivalent to specifying the
bcf9626a 550 option `--use-client-spec`. See the "CLIENT SPEC" section above.
896a6816 551 This variable is a boolean, not the name of a p4 client.
6679c34c 552
a9e38359
LS
553git-p4.pathEncoding::
554 Perforce keeps the encoding of a path as given by the originating OS.
555 Git expects paths encoded as UTF-8. Use this config to tell git-p4
556 what encoding Perforce had used for the paths. This encoding is used
557 to transcode the paths to UTF-8. As an example, Perforce on Windows
c6a896b6 558 often uses "cp1252" to encode path names.
a9e38359 559
a5db4b12
LS
560git-p4.largeFileSystem::
561 Specify the system that is used for large (binary) files. Please note
562 that large file systems do not support the 'git p4 submit' command.
887523eb
LS
563 Only Git LFS is implemented right now (see https://git-lfs.github.com/
564 for more information). Download and install the Git LFS command line
565 extension to use this option and configure it like this:
a5db4b12
LS
566+
567-------------
568git config git-p4.largeFileSystem GitLFS
569-------------
a5db4b12
LS
570
571git-p4.largeFileExtensions::
572 All files matching a file extension in the list will be processed
573 by the large file system. Do not prefix the extensions with '.'.
574
575git-p4.largeFileThreshold::
576 All files with an uncompressed size exceeding the threshold will be
577 processed by the large file system. By default the threshold is
578 defined in bytes. Add the suffix k, m, or g to change the unit.
579
580git-p4.largeFileCompressedThreshold::
581 All files with a compressed size exceeding the threshold will be
582 processed by the large file system. This option might slow down
583 your clone/sync process. By default the threshold is defined in
584 bytes. Add the suffix k, m, or g to change the unit.
585
586git-p4.largeFilePush::
587 Boolean variable which defines if large files are automatically
588 pushed to a server.
589
4ae048e6
LS
590git-p4.keepEmptyCommits::
591 A changelist that contains only excluded files will be imported
592 as an empty commit if this boolean option is set to true.
593
10d08a14
LS
594git-p4.mapUser::
595 Map a P4 user to a name and email address in Git. Use a string
596 with the following format to create a mapping:
597+
598-------------
599git config --add git-p4.mapUser "p4user = First Last <mail@address.com>"
600-------------
601+
602A mapping will override any user information from P4. Mappings for
603multiple P4 user can be defined.
604
6679c34c
PW
605Submit variables
606~~~~~~~~~~~~~~~~
607git-p4.detectRenames::
84cb0003
GG
608 Detect renames. See linkgit:git-diff[1]. This can be true,
609 false, or a score as expected by 'git diff -M'.
6679c34c
PW
610
611git-p4.detectCopies::
84cb0003
GG
612 Detect copies. See linkgit:git-diff[1]. This can be true,
613 false, or a score as expected by 'git diff -C'.
6679c34c
PW
614
615git-p4.detectCopiesHarder::
84cb0003 616 Detect copies harder. See linkgit:git-diff[1]. A boolean.
6679c34c
PW
617
618git-p4.preserveUser::
2de9b711 619 On submit, re-author changes to reflect the Git author,
6679c34c
PW
620 regardless of who invokes 'git p4 submit'.
621
622git-p4.allowMissingP4Users::
623 When 'preserveUser' is true, 'git p4' normally dies if it
624 cannot find an author in the p4 user map. This setting
625 submits the change regardless.
626
627git-p4.skipSubmitEdit::
628 The submit process invokes the editor before each p4 change
629 is submitted. If this setting is true, though, the editing
630 step is skipped.
631
632git-p4.skipSubmitEditCheck::
633 After editing the p4 change message, 'git p4' makes sure that
634 the description really was changed by looking at the file
635 modification time. This option disables that test.
636
637git-p4.allowSubmit::
638 By default, any branch can be used as the source for a 'git p4
639 submit' operation. This configuration variable, if set, permits only
28755dba
PW
640 the named branches to be used as submit sources. Branch names
641 must be the short names (no "refs/heads/"), and should be
642 separated by commas (","), with no spaces.
6679c34c
PW
643
644git-p4.skipUserNameCheck::
645 If the user running 'git p4 submit' does not exist in the p4
646 user map, 'git p4' exits. This option can be used to force
647 submission regardless.
648
41925d58 649git-p4.attemptRCSCleanup::
06804c76
LD
650 If enabled, 'git p4 submit' will attempt to cleanup RCS keywords
651 ($Header$, etc). These would otherwise cause merge conflicts and prevent
652 the submit going ahead. This option should be considered experimental at
653 present.
654
655git-p4.exportLabels::
2de9b711 656 Export Git tags to p4 labels, as per --export-labels.
06804c76 657
c8942a22 658git-p4.labelExportRegexp::
06804c76 659 Only p4 labels matching this regular expression will be exported. The
c8942a22 660 default value is '[a-zA-Z0-9_\-.]+$'.
6679c34c 661
6bbfd137
PW
662git-p4.conflict::
663 Specify submit behavior when a conflict with p4 is found, as per
664 --conflict. The default behavior is 'ask'.
665
3b3477ea
LD
666git-p4.disableRebase::
667 Do not rebase the tree against p4/master following a submit.
668
b9d34db9
LD
669git-p4.disableP4Sync::
670 Do not sync p4/master with Perforce following a submit. Implies git-p4.disableRebase.
671
6679c34c
PW
672IMPLEMENTATION DETAILS
673----------------------
2de9b711 674* Changesets from p4 are imported using Git fast-import.
6679c34c
PW
675* Cloning or syncing does not require a p4 client; file contents are
676 collected using 'p4 print'.
677* Submitting requires a p4 client, which is not in the same location
2de9b711 678 as the Git repository. Patches are applied, one at a time, to
6679c34c
PW
679 this p4 client and submitted from there.
680* Each commit imported by 'git p4' has a line at the end of the log
681 message indicating the p4 depot location and change number. This
682 line is used by later 'git p4 sync' operations to know which p4
683 changes are new.