Proofreading and tidying up of ccm doc page. One further action might be to
refactor the table into 'common attributes' and task specific attrs.
-steve
Index: ccm.html
===================================================================
RCS file: /home/cvspublic/jakarta-ant/docs/manual/OptionalTasks/ccm.html,v
retrieving revision 1.1
diff -u -r1.1 ccm.html
--- ccm.html 2001/07/27 09:14:58 1.1
+++ ccm.html 2001/08/19 07:14:43
@@ -16,12 +16,12 @@
<li><a href="#ccmcreatetask">CCMCreateTask</a></li>
</ul>
-<p>These ant tasks are wrapper around Continnus Source Manager. It have been
tested
- under version 5.1 on Windows 2000.</p>
+<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 perform a Checkin command to Continnus
+Task to checkin a file
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0" width="598">
<tr>
@@ -36,29 +36,29 @@
</tr>
<tr>
<td>comment</td>
- <td>Specify a comment.</td>
+ <td>Specify a comment. Default is "Checkin" plus the date</td>
<td>No</td>
</tr>
<tr>
<td>task</td>
- <td>Specify the task number used to checkin the file (may use
'default')</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 excutable file. default serach into the PATH</td>
+ <td>path to the ccm executable file, required if it is not on the PATH</td>
<td>No</td>
</tr>
-</table>
+</table>
<h3>Examples</h3>
<blockquote>
<pre><ccmcheckin file="c:/wa/com/foo/MyFile.java"
comment="mycomment" />
</pre>
</blockquote>
-<p>Does a Continnuus <i>checkin</i> on the file
<i>c:/wa/com/foo/MyFile.java</i>.
+<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 fault.</p>
+ used is the one set as the default.</p>
<hr>
<h2><a name="cccheckout">CCMCheckout</a></h2>
<h3>Description</h3>
@@ -66,45 +66,45 @@
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0" width="614">
<tr>
- <th width="84">Attribute</th>
- <th width="396">Values</th>
- <th width="24">Required</th>
+ <th>Attribute</th>
+ <th>Values</th>
+ <th>Required</th>
</tr>
<tr>
- <td width="84">file</td>
- <td width="396">Path to the file that the command will operate on</td>
- <td width="24">Yes</td>
+ <td>file</td>
+ <td>Path to the file that the command will operate on</td>
+ <td>Yes</td>
</tr>
<tr>
- <td width="84">comment</td>
- <td width="396">Specify a comment.</td>
- <td width="24">No</td>
+ <td>comment</td>
+ <td>Specify a comment.</td>
+ <td>No</td>
</tr>
<tr>
- <td width="84">task</td>
- <td width="396">Specify the task number used to checkin the file (may use
+ <td>task</td>
+ <td>Specify the task number used to checkin the file (may use
'default')</td>
- <td width="24">No</td>
+ <td>No</td>
</tr>
<tr>
- <td width="84">ccmcommand</td>
- <td width="396">path to the ccm excutable file. default serach into the
PATH</td>
- <td width="24">No</td>
+ <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><ccmcheckin file="c:/wa/com/foo/MyFile.java"
+ <pre><ccmcheckout file="c:/wa/com/foo/MyFile.java"
comment="mycomment"/>
</pre>
</blockquote>
-<p>Does a Continnuus <i>checkout</i> on the file
<i>c:/wa/com/foo/MyFile.java</i>.
+<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 fault.</p>
+ 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 Continnuus
+Task to perform a check in default task command to Continuus
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
@@ -119,12 +119,12 @@
</tr>
<tr>
<td>task</td>
- <td>Specify the task number used to checkin the file (may use
'default')</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 excutable file. default serach into the PATH</td>
+ <td >path to the ccm executable file, required if it is not on the
PATH</td>
<td>No</td>
</tr>
</table>
@@ -133,7 +133,7 @@
<pre><ccmcheckintask comment="blahblah/>
</pre>
</blockquote>
-<p>Does a Checkin default task on all the checkou-ed filed in the current
task.</p>
+<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>
@@ -162,22 +162,22 @@
</tr>
<tr>
<td>ccmcommand</td>
- <td>path to the ccm excutable file. default serach into the PATH</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><ccmreconfigure ccmproject="ANTCCM_TEST#BMO_1"
verbose="true" />
-
+ <pre><ccmreconfigure ccmproject="ANTCCM_TEST#BMO_1"
+ verbose="true" />
</pre>
</blockquote>
-<p>Does a Continuus <i>reconfiguree</i> on the project
<i>ANTCCM_TEST#BMO_1</i>.
+<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>
-Task to perform an create task command to Continuus.
+Create a Continuus task.
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
@@ -197,7 +197,7 @@
</tr>
<tr>
<td>ccmcommand</td>
- <td>path to the ccm excutable file. default serach into the PATH</td>
+ <td >path to the ccm executable file, required if it is not on the
PATH</td>
<td>No</td>
</tr>
<tr>
@@ -223,12 +223,12 @@
</table>
<h3>Examples</h3>
<blockquote>
- <pre><ccmcreatetask resolver="{user.name}"
release="ANTCCM_TEST" comment="blahblah" />
+ <pre><ccmcreatetask resolver="${user.name}"
+ release="ANTCCM_TEST" comment="blahblah" />
</pre>
</blockquote>
-<p>Does a Continuus <i>create task</i> for the release <i>ANTCCM_TEST</i> to
the
- current logged person as the resolver for this task.</p>
-<p> </p>
+<p>Creates a task for the release <i>ANTCCM_TEST</i> with the
+ current user as the resolver for this task.</p>
</body>
