Google Git
Sign in
apache / ant / 542b54ebefac71b17f4f2f8be9114a011c08b64d / . / docs / manual / OptionalTasks / ccm.html
blob: 0b405a7838e72df8ddaea1370a23079c19e81045 [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
<title>Ant</title>
</head>
<body>
<h1>Continuus Support</h1>
<ul>
<li><a href="#cccheckin">CCMCheckin</a></li>
<li><a href="#cccheckout">CCMCheckout</a></li>
<li><a href="#ccmcheckintask">CCMCheckinTask</a></li>
<li><a href="#ccmreconfigure">CCMReconfigure</a></li>
<li><a href="#ccmcreatetask">CCMCreateTask</a></li>
</ul>
<p>These ant tasks are wrappers around Continuus Source Manager. They have been tested
with version 5.1 on Windows 2000, but should work on other platforms with ccm installed.</p>
<hr>
<h2><a name="cccheckin">CCMCheckin</a></h2>
<h3>Description</h3>
Task to checkin a file
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0" width="598">
<tr>
<th>Attribute</th>
<th>Values</th>
<th>Required</th>
</tr>
<tr>
<td>file</td>
<td>Path to the file that the command will operate on</td>
<td>Yes</td>
</tr>
<tr>
<td>comment</td>
<td>Specify a comment. Default is &quot;Checkin&quot; plus the date</td>
<td>No</td>
</tr>
<tr>
<td>task</td>
<td>Specify the task number used to check in the file (may use 'default')</td>
<td>No</td>
</tr>
<tr>
<td>ccmcommand</td>
<td>path to the ccm executable file, required if it is not on the PATH</td>
<td>No</td>
</tr>
</table>
<h3>Examples</h3>
<blockquote>
<pre>&lt;ccmcheckin file=&quot;c:/wa/com/foo/MyFile.java&quot;
comment=&quot;mycomment&quot; /&gt;
</pre>
</blockquote>
<p>Checks in the file <i>c:/wa/com/foo/MyFile.java</i>.
Comment attribute <i>mycomment</i> is added as a task comment. The task
used is the one set as the default.</p>
<hr>
<h2><a name="cccheckout">CCMCheckout</a></h2>
<h3>Description</h3>
Task to perform a Checkout command to Continuus
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0" width="614">
<tr>
<th>Attribute</th>
<th>Values</th>
<th>Required</th>
</tr>
<tr>
<td>file</td>
<td>Path to the file that the command will operate on</td>
<td>Yes</td>
</tr>
<tr>
<td>comment</td>
<td>Specify a comment.</td>
<td>No</td>
</tr>
<tr>
<td>task</td>
<td>Specify the task number used to checkin the file (may use
'default')</td>
<td>No</td>
</tr>
<tr>
<td>ccmcommand</td>
<td>path to the ccm executable file, required if it is not on the PATH</td>
<td>No</td>
</tr>
</table>
<h3>Examples</h3>
<blockquote>
<pre>&lt;ccmcheckout file=&quot;c:/wa/com/foo/MyFile.java&quot;
comment=&quot;mycomment&quot;/&gt;
</pre>
</blockquote>
<p>Check out the file <i>c:/wa/com/foo/MyFile.java</i>.
Comment attribute <i>mycomment</i> is added as a task comment
The used task is the one set as the default.</p>
<hr>
<h2><a name="ccmcheckintask">CCMCheckinTask</a></h2>
<h3>Description</h3>
Task to perform a check in default task command to Continuus
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>Attribute</th>
<th>Values</th>
<th>Required</th>
</tr>
<tr>
<td>comment</td>
<td>Specify a comment.</td>
<td>No</td>
</tr>
<tr>
<td>task</td>
<td>Specify the task number used to check in the file (may use 'default')</td>
<td>No</td>
</tr>
<tr>
<td>ccmcommand</td>
<td >path to the ccm executable file, required if it is not on the PATH</td>
<td>No</td>
</tr>
</table>
<h3>Examples </h3>
<blockquote>
<pre>&lt;ccmcheckintask comment=&quot;blahblah/&gt;
</pre>
</blockquote>
<p>Does a Checkin default task on all the checked out files in the current task.</p>
<hr>
<h2><a name="ccmreconfigure">CCMReconfigure</a></h2>
<h3>Description</h3>
Task to perform an reconfigure command to Continuus.
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>Attribute</th>
<th>Values</th>
<th>Required</th>
</tr>
<tr>
<td>recurse</td>
<td>recurse on subproject (default false)</td>
<td>No</td>
</tr>
<tr>
<td>verbose</td>
<td>do a verbose reconfigure operation (default false)</td>
<td>No</td>
</tr>
<tr>
<td>ccmproject</td>
<td>Specifies the ccm project on which the operation is applied.</td>
<td>Yes</td>
</tr>
<tr>
<td>ccmcommand</td>
<td >path to the ccm executable file, required if it is not on the PATH</td>
<td>No</td>
</tr>
</table>
<h3>Examples</h3>
<blockquote>
<pre>&lt;ccmreconfigure ccmproject=&quot;ANTCCM_TEST#BMO_1&quot;
verbose=&quot;true&quot; /&gt;
</pre>
</blockquote>
<p>Does a Continuus <i>reconfigure</i> on the project <i>ANTCCM_TEST#BMO_1</i>.
</p>
<hr>
<h2><a name="ccmcreatetask">CCMCreateTask</a></h2>
<h3>Description</h3>
Create a Continuus task.
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>Attribute</th>
<th>Values</th>
<th>Required</th>
</tr>
<tr>
<td>comment</td>
<td>Specify a comment.</td>
<td>No</td>
</tr>
<tr>
<td>platform</td>
<td>Specify the target platform</td>
<td>No</td>
</tr>
<tr>
<td>ccmcommand</td>
<td >path to the ccm executable file, required if it is not on the PATH</td>
<td>No</td>
</tr>
<tr>
<td>resolver</td>
<td>Specify the resolver</td>
<td>No</td>
</tr>
<tr>
<td>release</td>
<td>Specify the CCM release</td>
<td>No</td>
</tr>
<tr>
<td>subsystem</td>
<td>Specify the subsystem</td>
<td>No</td>
</tr>
<tr>
<td>task</td>
<td>Specify the task number used to checkin the file (may use 'default')</td>
<td>No</td>
</tr>
</table>
<h3>Examples</h3>
<blockquote>
<pre>&lt;ccmcreatetask resolver=&quot;${user.name}&quot;
release=&quot;ANTCCM_TEST&quot; comment=&quot;blahblah&quot; /&gt;
</pre>
</blockquote>
<p>Creates a task for the release <i>ANTCCM_TEST</i> with the
current user as the resolver for this task.</p>
</body>
</html>