summaryrefslogtreecommitdiff
path: root/manual/Tasks/ccm.html
blob: 2074bb211c6578053770473e3c13ec89668ddaef (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
<!--
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
-->
<html>

<head>
<meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>Continuus Tasks</title>
</head>

<body>

<h1>Continuus Support</h1>
<ul>
  <li><a href="#ccmcheckin">CCMCheckin</a></li>
  <li><a href="#ccmcheckout">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 Apache Ant tasks are wrappers
around <a href="https://en.wikipedia.org/wiki/Rational_Synergy" target="_top">Continuus Source
Manager</a>. They have been tested against versions 5.1/6.2 on Windows 2000, but should work on
other platforms with <kbd>ccm</kbd> installed.</p>

<hr/>

<h2 id="ccmcheckin">CCMCheckin</h2>
<h3>Description</h3>
<p>Check in a file to Continuus</p>
<h3>Parameters</h3>
<table class="attr">
  <tr>
    <th scope="col">Attribute</th>
    <th scope="col">Values</th>
    <th scope="col">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; default is <q>Checkin</q> plus the date</td>
  </tr>
  <tr>
    <td>task</td>
    <td>Specify the task number used to check in the file (may use <q>default</q>)</td>
    <td>No</td>
  </tr>
  <tr>
    <td>ccmdir</td>
    <td>path to the <kbd>ccm</kbd> executable file, required if it is not on
    the <code>PATH</code></td>
    <td>No</td>
  </tr>
</table>
<h3>Examples</h3>

<p>Check in the file <samp>c:/wa/com/foo/MyFile.java</samp>.  Text <samp>mycomment</samp> is added
as a comment. The task used is the one set as the default.</p>
<pre>
&lt;ccmcheckin file=&quot;c:/wa/com/foo/MyFile.java&quot;
            comment=&quot;mycomment&quot;/&gt;</pre>

<hr/>

<h2 id="ccmcheckout">CCMCheckout</h2>
<h3>Description</h3>
<p>Run a Continuus checkout command</p>
<h3>Parameters</h3>
<table class="attr">
  <tr>
    <th scope="col">Attribute</th>
    <th scope="col">Values</th>
    <th scope="col">Required</th>
  </tr>
  <tr>
    <td>file</td>
    <td>Path to the file that the command will operate on</td>
    <td rowspan="2">Exactly one of the two</td>
  </tr>
  <tr>
    <td>fileset</td>
    <td class="left">fileset containing the file to be checked out</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 <q>default</q>)</td>
    <td>No</td>
  </tr>
  <tr>
    <td>ccmdir</td>
    <td>path to the <kbd>ccm</kbd> executable file, required if it is not on
    the <code>PATH</code></td>
    <td>No</td>
  </tr>
</table>
<h3>Examples</h3>

<p>Check out the file <samp>c:/wa/com/foo/MyFile.java</samp>.  Comment
attribute <samp>mycomment</samp> is added as a task comment. The task used is the one set as the
default.</p>
<pre>
&lt;ccmcheckout file=&quot;c:/wa/com/foo/MyFile.java&quot;
             comment=&quot;mycomment&quot;/&gt;</pre>

<p>Check out all the files in the <samp>lib</samp> directory having the <samp>.jar</samp>
extension. Comment attribute <samp>mycomment</samp> is added as a task comment The used task is the
one set as the default.</p>
<pre>
&lt;ccmcheckout comment=&quot;mycomment&quot;&gt;
  &lt;fileset dir=&quot;lib&quot; &gt;
    &lt;include name=&quot;**/*.jar&quot;/&gt;
  &lt;/fileset&gt;
&lt;/ccmcheckout &gt;</pre>

<hr/>

<h2 id="ccmcheckintask">CCMCheckinTask</h2>
<h3>Description</h3>
<p>Run a Continuus command to checkin default task</p>
<h3>Parameters</h3>
<table class="attr">
  <tr>
    <th scope="col">Attribute</th>
    <th scope="col">Values</th>
    <th scope="col">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 <q>default</q>)</td>
    <td>No</td>
  </tr>
  <tr>
    <td>ccmdir</td>
    <td>path to the <kbd>ccm</kbd> executable file, required if it is not on
    the <code>PATH</code></td>
    <td>No</td>
  </tr>
</table>
<h3>Examples</h3>

<p>Perform a Checkin default task on all the checked out files in the current task.</p>
<pre>&lt;ccmcheckintask comment=&quot;blahblah/&gt;</pre>

<hr/>

<h2 id="ccmreconfigure">CCMReconfigure</h2>
<h3>Description</h3>
<p>Run a Continuus reconfigure/update command</p>
<h3>Parameters</h3>
<table class="attr">
  <tr>
    <th scope="col">Attribute</th>
    <th scope="col">Values</th>
    <th scope="col">Required</th>
  </tr>
  <tr>
    <td>recurse</td>
    <td>recurse on subproject</td>
    <td>No; default is <q>false</q></td>
  </tr>
  <tr>
    <td>verbose</td>
    <td>do a verbose reconfigure operation</td>
    <td>No; default is <q>false</q></td>
  </tr>
  <tr>
    <td>ccmproject</td>
    <td>Specifies the ccm project on which the operation is applied.</td>
    <td>Yes</td>
  </tr>
  <tr>
    <td>ccmdir</td>
    <td>path to the <kbd>ccm</kbd> executable file, required if it is not on
    the <code>PATH</code></td>
    <td>No</td>
  </tr>
</table>
<h3>Examples</h3>

<p>Perform a Continuus <code>reconfigure</code> on the project <samp>ANTCCM_TEST#BMO_1</samp>.</p>
<pre>
&lt;ccmreconfigure ccmproject=&quot;ANTCCM_TEST#BMO_1&quot;
                verbose=&quot;true&quot;/&gt;</pre>

<hr/>

<h2 id="ccmcreatetask">CCMCreateTask</h2>
<h3>Description</h3>
<p>Create a Continuus task.</p>
<h3>Parameters</h3>
<table class="attr">
  <tr>
    <th scope="col">Attribute</th>
    <th scope="col">Values</th>
    <th scope="col">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>ccmdir</td>
    <td>path to the <kbd>ccm</kbd> executable file, required if it is not on
    the <code>PATH</code></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 <q>default</q>)</td>
    <td>No</td>
  </tr>
</table>
<h3>Examples</h3>

<p>Create a task for the release <samp>ANTCCM_TEST</samp> with the current user as the resolver for
this task.</p>
<pre>
&lt;ccmcreatetask resolver=&quot;${user.name}&quot;
               release=&quot;ANTCCM_TEST&quot; comment=&quot;blahblah&quot;/&gt;</pre>

</body>
</html>