Return-Path: Delivered-To: apmail-jakarta-ant-dev-archive@apache.org Received: (qmail 45390 invoked from network); 18 Dec 2001 22:22:55 -0000 Received: from unknown (HELO nagoya.betaversion.org) (192.18.49.131) by daedalus.apache.org with SMTP; 18 Dec 2001 22:22:55 -0000 Received: (qmail 7718 invoked by uid 97); 18 Dec 2001 22:18:27 -0000 Delivered-To: qmlist-jakarta-archive-ant-dev@jakarta.apache.org Received: (qmail 7664 invoked by uid 97); 18 Dec 2001 22:18:26 -0000 Mailing-List: contact ant-dev-help@jakarta.apache.org; run by ezmlm Precedence: bulk List-Unsubscribe: List-Subscribe: List-Help: List-Post: List-Id: "Ant Developers List" Reply-To: "Ant Developers List" Delivered-To: mailing list ant-dev@jakarta.apache.org Received: (qmail 7577 invoked by uid 97); 18 Dec 2001 22:18:26 -0000 Date: 18 Dec 2001 22:18:18 -0000 Message-ID: <20011218221818.43573.qmail@icarus.apache.org> From: sbailliez@apache.org To: jakarta-ant-cvs@apache.org Subject: cvs commit: jakarta-ant/docs/manual optionaltasklist.html X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N sbailliez 01/12/18 14:18:18 Modified: docs/manual/OptionalTasks starteam.html docs/manual optionaltasklist.html Log: Major refactoring of Starteam tasks. This is based on the original submission from the CruiseControl project. Original task has been deprecated Starteam tasks now resides in the starteam package rather than scm. Submitted by: stevec@ignitesports.com (Steve Cohen) Revision Changes Path 1.6 +283 -15 jakarta-ant/docs/manual/OptionalTasks/starteam.html Index: starteam.html =================================================================== RCS file: /home/cvs/jakarta-ant/docs/manual/OptionalTasks/starteam.html,v retrieving revision 1.5 retrieving revision 1.6 diff -u -r1.5 -r1.6 --- starteam.html 2001/12/11 21:08:23 1.5 +++ starteam.html 2001/12/18 22:18:17 1.6 @@ -4,53 +4,300 @@ Apache Ant User Manual +

StarTeam Support

STCheckout
STLabel
StarTeam (deprecated)

Starteam

+These tasks make use of functions from the StarTeam API. As a result +they are only available to licensed users of StarTeam. You must have +starteam-sdk.jar in your classpath to run these tasks. +For more information about the StarTeam API and how to license it, see +the StarBase web site.

+ +

STCheckout

Description

Checks out files from a StarTeam project.

The includes and excludes attributes function differently from -other tasks in Ant. Multiple patterns must be separated by spaces, not -commas. See the examples for more information.

- -

-This program makes use of functions from the StarTeam API. As a result -this task is only available to licensed users of StarTeam. You must have -starteam-sdk.jar in your classpath to run this task. -For more information about the StarTeam API and how to license it, see -the StarBase web site.

+other tasks in Ant. Inclusion/exclusion by folder is NOT supported. +

Parameters

- - - + + + + + + + + + + + + + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Attribute	Description	Required	username	The username of the account used to log in to the StarTeam server.	yes
password	The password of the account used to log in to the StarTeam server.	yes
URL	A string of the form `"servername:portnum/project/view` +which enables user to set all of these elements in one string.	yes*
servername	The name of the StarTeam server.	yes	yes*
serverport	The port number of the StarTeam server.	yes	yes*
projectname	The name of the StarTeam project.	yes*
viewname	The name of the view in the StarTeam project.	yes*
rootstarteamfolder	The root of the subtree in the StarTeam repository from which to + check out files. Defaults to the root folder of the view ('/').	no
rootlocalfolder	The local folder which will be the root of the tree to which files are checked out. If this is not supplied, then the StarTeam "default folder" associated with rootstarteamfolder is used.	no
createworkingdirs	creates local folders even when the corresponding StarTeam folder is empty. Defaults to "true".	no
deleteuncontrolled	if true, any files NOT in StarTeam will be deleted. Defaults to "true".	no
includes	Only check out files that match at least one of the patterns in this list. Patterns must be separated by commas. Patterns in excludes take precedence over patterns in includes.	no
excludes	Do not check out files that match at least one of the patterns in this list. Patterns must be separated by commas. Patterns in excludes take precedence over patterns in includes.	no

+ +* Either the URL attribute or all four of the servername, serverport, projectname and viewname attributes must be defined.
+ +

Examples

+ +

  +  <stcheckout servername="STARTEAM" 
  +            serverport="49201"
  +            projectname="AProject" 
  +            viewname="AView"
  +            username="auser"
  +            password="secret"
  +            rootlocalfolder="C:\dev\buildtest\co"
  +  />
  +

+ +The minimum necessary to check out files out from a StarTeam server. This will +check out all files in the AView view of the AProject project to +C:\dev\buildtest\co. Empty folders in StarTeam will have local folders +created for them and any non-StarTeam files found in the tree will be deleted. + +Or more simply: +

  +  <stcheckout URL="STARTEAM:49201/Aproject/AView" 
  +            username="auser"
  +            password="secret"
  +            rootlocalfolder="C:\dev\buildtest\co"
  +  />
  +

+

+

  +  <stcheckout URL="STARTEAM:49201/Aproject/AView" 
  +            username="auser"
  +            password="secret"
  +            rootlocalfolder="C:\dev\buildtest\co"
  +            rootstarteamfolder="\Dev"
  +            excludes="*.bak *.old"
  +  />
  +

+ +This will checkout all files from the Dev folder and below that do not +end in .bak or .old. + +

  +  <stcheckout URL="STARTEAM:49201/Aproject/AView"
  +            username="auser"
  +            password="secret"
  +            rootlocalfolder="C:\dev\buildtest\co"
  +            includes="*.htm,*.html"
  +            excludes="index.*"
  +  />
  +

+ + + +This is an example of overlapping includes and excludes attributes. Because +excludes takes precedence over includes, files named index.html will +not be checked out by this command. + + +

  +  <stcheckout URL="STARTEAM:49201/Aproject/AView"
  +            username="auser"
  +            password="secret"
  +            rootstarteamfolder="src/java"
  +            rootlocalfolder="C:\dev\buildtest\co"
  +  />
  +

+

+

  +  <stcheckout URL="STARTEAM:49201/Aproject/AView"
  +            username="auser"
  +            password="secret"
  +            rootstarteamfolder="src/java"
  +  />
  +

+

+

  + <stcheckout URL="STARTEAM:49201/Aproject/AView"
  +            username="auser"
  +            password="secret"
  +            rootstarteamfolder="src/java"
  +            rootlocalfolder="C:\dev\buildtest\co\src\java"
  +  />
  +

+ +In the preceding three examples, assuming that the AProject project has a default folder of +"AProject", the first example will check the files located in starteam under src/java out to a tree rooted at C:\dev\buildtest\co, +the second to a tree rooted at C:\dev\buildtest\co\AProject\src\java and the third to a tree rooted at C:\dev\buildtest\co\src\java. + + +

STLabel

+ +

Description

+ +Creates a view label in StarTeam at the specified view. The label will be classified by StarTeam as a "build label". This task will fail if there already exexists in viewname a label with the same name as the label parameter. + +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

username	The username of the account used to log in to the StarTeam server.	yes
password	The password of the account used to log in to the StarTeam server.	yes
URL	A string of the form `"servername:portnum/project/view"` +which enables user to set all of these elements in one string.	yes*
servername	The name of the StarTeam server.	yes*
serverport	The port number of the StarTeam server.	yes*
projectname	The name of the StarTeam project.	yes*
viewname	The name of the view in the StarTeam project.	yes*
label	The name to be given to the label	yes
lastbuild	The timestamp of the build that will be stored with the label. Must be formatted `yyyyMMddHHmmss`	yes
description	A description of the view to be stored in the StarTeam project.	no

+* Either the URL attribute or all four of the servername, serverport, projectname and viewname attributes must be defined.
+ +

Examples

+ +This example shows the use of this tag. It will create a label named Version 6.2 with +"Thorough description" as its description. +

  +  <tstamp>
  +    <format property="nowstamp" pattern="yyyyMMddHHmmss" locale="en"/>
  +  </tstamp>  
  +  <starteamlabel URL="STARTEAM:49201/Aproject/AView"
  +            username="auser"
  +            password="secret"
  +            label="Version 6.2"
  +            lastbuild="${nowstamp}"
  +            description-"Thorough description"
  +  />
  +

+ +

+ + +

Starteam

Deprecated

This task has been deprecated. Use the STCheckout task instead.

Description

+ +Checks out files from a StarTeam project. + +

+The includes and excludes attributes function differently from +other tasks in Ant. Multiple patterns must be separated by spaces, not +commas. See the examples for more information.

+ +

Parameters

+ + + + + + + @@ -59,7 +306,28 @@ + + + + + + + + + + + + + + + + + + + + + 1.22 +1 -1 jakarta-ant/docs/manual/optionaltasklist.html Index: optionaltasklist.html =================================================================== RCS file: /home/cvs/jakarta-ant/docs/manual/optionaltasklist.html,v retrieving revision 1.21 retrieving revision 1.22 diff -u -r1.21 -r1.22 --- optionaltasklist.html 2001/11/12 11:26:48 1.21 +++ optionaltasklist.html 2001/12/18 22:18:17 1.22 @@ -43,7 +43,7 @@ Rpm
Script
Sound
-Starteam
+Starteam Tasks
Stylebook
Telnet
Test
-- To unsubscribe, e-mail: For additional commands, e-mail:

Attribute	Description	Required
username	The username of the account used to log in to the StarTeam server.	yes	password	The password of the account used to log in to the StarTeam server.	yes
servername	The name of the StarTeam server.	yes
serverport	The port number of the StarTeam server.	yes
projectname	The name of the StarTeam project.	yes
viewname	The name of the view in the StarTeam project.	yes
targetfolder	The folder to which files are checked out. What this precisely means is determined by the targetFolderAbsolute param.