Perforce Tasks User Manual

by

• Les Hughes (leslie.hughes@rubus.com)
• Kirk Wylie (kirk@radik.com)

Version 1.1 - 2001/01/09

Contents

• Introduction
• The Tasks
• Change History

Introduction

These tasks provide an interface to the Perforce SCM. The org.apache.tools.ant.taskdefs.optional.perforce package consists of a simple framework to support p4 functionality as well as some Ant tasks encapsulating frequently used (by me :-) p4 commands. However, the addition of new p4 commands is a pretty simple task (see the source). Although it is possible to use these commands on the desktop, they were primarily intended to be used by automated build systems.

Note: These tasks require the oro 2.0.XXX regular expression package. Simply download this package and copy the jakarta-oro-2.0.XXX.jar file into Ant's lib directory. You will also need the Perforce client executable (p4 or p4.exe but not p4win.exe) in your path.

The Tasks

General P4 Properties

Each p4 task requires a number of settings, either through build-wide properties, individual attributes or environment variables. These are

Your local installation of Perforce may require other settings (e.g. P4PASSWD, P4CONFIG). At the moment, these can only be set outside of Ant, as environment variables.

Additionally, you may also specify the following attributes:

Attribute	Description	Required
failonerror	Specifies whether to stop the build (true|yes|on) or keep going (false|no|off) if an error is returned from the p4 command.	No; defaults to true.

Examples

Setting in the environment:-

(Unix csh)

setenv P4PORT myperforcebox:1666

(Unix sh et al)

P4USER=myp4userid; export P4USER

Using build properties:-

<property name="p4.client" value="nightlybuild"/>

Using task attributes:-

<p4Whatever

	port="myserver:1666"

	client="smoketest"

	user="smoketestdude"

	.

	.

	.

/>

For more information regarding the underlying 'p4' commands you are referred to the Perforce Command Reference available from the Perforce website.

Taskdefs

Standard taskdefs (for you to copy'n'paste) -- normally this is done automatically if you install this optional task.

    <taskdef name="p4sync" classname="org.apache.tools.ant.taskdefs.optional.perforce.P4Sync"/>

    <taskdef name="p4change" classname="org.apache.tools.ant.taskdefs.optional.perforce.P4Change"/>

    <taskdef name="p4edit" classname="org.apache.tools.ant.taskdefs.optional.perforce.P4Edit"/>

    <taskdef name="p4submit" classname="org.apache.tools.ant.taskdefs.optional.perforce.P4Submit"/>

    <taskdef name="p4have" classname="org.apache.tools.ant.taskdefs.optional.perforce.P4Have"/>

    <taskdef name="p4label" classname="org.apache.tools.ant.taskdefs.optional.perforce.P4Label"/>

    <taskdef name="p4counter" classname="org.apache.tools.ant.taskdefs.optional.perforce.P4Counter"/>

    <taskdef name="p4reopen" classname="org.apache.tools.ant.taskdefs.optional.perforce.P4Reopen"/>

    <taskdef name="p4revert" classname="org.apache.tools.ant.taskdefs.optional.perforce.P4Revert"/>

    <taskdef name="p4add" classname="org.apache.tools.ant.taskdefs.optional.perforce.P4Add"/>

Task Descriptions

P4Sync

Description:

Synchronize the current workspace with the depot.

Parameters

Examples

<p4sync label="nightlybuild-0.0123" force="foo"/>

<p4sync view="//depot/projects/projectfoo/main/src/..."/>

P4Change

Description:

Request a new changelist from the Perforce server. This task sets the ${p4.change} property which can then be passed to P4Submit, P4Edit, or P4Add.

Parameters

Examples

<p4change description="Change Build Number in Script">

P4Edit

Description:

Open file(s) for edit. P4Change should be used to obtain a new changelist for P4Edit as, although P4Edit can open files to the default change, P4Submit cannot yet submit it.

Parameters

Examples

<p4edit

    view="//depot/projects/projectfoo/main/src/Blah.java..."

    change="${p4.change}"/>

P4Submit

Description:

Submit a changelist, usually obtained from P4Change.

Parameters

Examples

<p4submit change="${p4.change}"/>

P4Have

Description:

List handy file info reflecting the current client contents.

Parameters

Examples

<p4have/>

P4Label

Description:

Create a new label and set contents to reflect current client file revisions.

Parameters

Examples

<p4label

	name="NightlyBuild:${DSTAMP}:${TSTAMP}" 

	desc="Auto Nightly Build"

	lock="locked"

/>

P4Counter

Description:

Obtain or set the value of a counter. When used in its base form (where only the counter name is provided), the counter value will be printed to the output stream. When the value is provided, the counter will be set to the value provided. When a property name is provided, the property will be filled with the value of the counter. You may not specify to both get and set the value of the counter in the same Task.

The user performing this task must have Perforce "review" permissions as defined by Perforce protections in order for this task to succeed.

Parameters

Examples

<p4counter name="last-clean-build"/>

<p4counter name="last-clean-build" value="${TSTAMP}"/>

<p4counter name="last-clean-build" property="${p4.last.clean.build}"/>

P4Reopen

Description:

Move (or reopen in Perforce speak) checkout files between changelists.

Parameters

Examples

<p4reopen view="//..." tochange="default"/>

<p4change description="Move files out of the way"/>

<p4reopen view="//projects/foo/main/..." tochange="${p4.change}"/>

P4Revert

Description:

Reverts files.

Parameters

Examples

<p4revert view="//..."/>

<p4revert change="default" revertonlyunchanged="true"/>

P4Add

Description:

Adds files specified in nested fileset children.

Parameters

Examples

<p4change/>

<p4add commandlength="20000" changelist="${p4.change}">

    <fileset dir="../dir/src/" includes="**/*.java"/>

<p4add>

<p4submit change="${p4.change}"/>

Change History

Copyright © 2001-2002 Apache Software Foundation. All rights Reserved.