Help
Task Reference
<p4sync>|
NAntContrib
Help
Task Reference
<p4sync> |
v0.85-rc1 |
[This is preliminary documentation and subject to change.]
Synchronize client space to a Perforce depot view.
| Attribute | Type | Description | Required |
|---|---|---|---|
| force | bool | Force a refresh of files. The default is false. | False |
| label | string | Label to sync client to; optional. | False |
| client | string | The p4 client spec to use. The default is the current client. | False |
| failonerror | bool | Determines if task failure stops the build, or is just reported. The default is true. | False |
| if | bool | If true then the task will be executed; otherwise, skipped. The default is true. | False |
| port | string | The p4 server and port to connect to. The default is "perforce:1666". | False |
| script | bool | Prepends a descriptive field (for example, text:, info:, error:, exit:) to each line of output produced by a Perforce command. This is most often used when scripting. The default is false. | False |
| timeout | int | The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out. | False |
| unless | bool | Opposite of if. If false then the task will be executed; otherwise, skipped. The default is false. |
False |
| user | string | The p4 username. The default is the current user. | False |
| verbose | bool | Determines whether the task should report detailed build log messages. The default is false. | False |
| view | string | The client, branch or label view to operate upon. The default is "//...". | False |
| Attribute | Type | Description | Required |
|---|---|---|---|
| useruntimeengine | bool | Specifies whether the external program should be executed using a runtime engine, if configured. The default is false. | False |
Contains a collection of Argument elements.
Sync to head using P4USER, P4PORT and P4CLIENT settings specified.
<p4Sync
view="//projects/foo/main/source/..."
user="fbloggs"
port="km01:1666"
client="fbloggsclient"
/>
Sync to head using default p4 environment variables.
<p4sync view="//projects/foo/main/source/..." />
Force a re-sync to head, refreshing all files.
<p4sync force="true" view="//projects/foo/main/source/..." />
Sync to a label.
<p4sync label="myPerforceLabel" />