source: other-projects/trunk/realistic-books/packages/AntInstaller/web/manual/manual/OptionalTasks/pvcstask.html@ 19253

Last change on this file since 19253 was 19253, checked in by davidb, 15 years ago

Establishing a source code repository for Veronica's Realistic Book's software
File size: 10.1 KB
Line 
1<!--
2 Licensed to the Apache Software Foundation (ASF) under one or more
3 contributor license agreements. See the NOTICE file distributed with
4 this work for additional information regarding copyright ownership.
5 The ASF licenses this file to You under the Apache License, Version 2.0
6 (the "License"); you may not use this file except in compliance with
7 the License. You may obtain a copy of the License at
8
9 http://www.apache.org/licenses/LICENSE-2.0
10
11 Unless required by applicable law or agreed to in writing, software
12 distributed under the License is distributed on an "AS IS" BASIS,
13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 See the License for the specific language governing permissions and
15 limitations under the License.
16-->
17<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
18<html>
19<head>
20 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
21 <meta http-equiv="Content-Language" content="en-us">
22 <link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
23<title>PVCS task</title>
24</head>
25<body>
26
27<h1>
28Ant Pvcs Task User Manual</h1>
29
30<p><b>Note:</b>
31Before using this task, the user running ant must have access to the
32commands of PVCS (get and pcli) and must have access to the
33repository. Note that the way to specify the repository is platform
34dependent so use property to specify location of repository.
35</p>
36
37by
38<br><!-- Names are in alphabetical order, on last name -->
39<ul>
40 <li>Thomas Christensen (<a href="mailto:[email protected]">[email protected]</a>)</li>
41 <li>Don Jeffery (<a href="mailto:[email protected]">[email protected]</a>)</li>
42 <li>Jon Dickinson (<a href="mailto:[email protected]">[email protected]</a>)</li>
43</ul>
44Version 1.1 - 2001/06/27<br>
45<p>Problems with UNC pathnames and the use of () in paths are fixed and an updateonly
46 argument introduced.</p>
47Version 1.0 - 2001/01/31<br>
48<p>Initial release.</p>
49<hr>
50<h2>
51Table of Contents</h2>
52<ul>
53 <li><a href="#introduction">Introduction</a></li>
54 <li><a href="#pvcs">Pvcs Task</a></li>
55</ul>
56<hr>
57
58<h2><a NAME="introduction">Introduction</a></h2>
59The pvcs task allows the user of ant to extract the latest edition
60of the source code from a PVCS repository. PVCS is a version control system
61developed by <a href="http://www.merant.com/products/pvcs">Merant</a>.
62<br>
63This version has been tested against PVCS version 6.5 and 6.6 under Windows and Solaris.
64
65<hr>
66<h2><a NAME="pvcs">Pvcs Task</a></h2>
67<h3>Description</h3>
68The pvcs task is set to point at a PVCS repository and optionally a project
69within that repository, and can from that specification get the latest
70version of the files contained by the repository.
71<h3>
72Parameters</h3>
73
74<table BORDER CELLSPACING=0 CELLPADDING=2 >
75<tr>
76<td VALIGN=TOP WIDTH="12%"><b>Attribute</b></td>
77
78<td VALIGN=TOP WIDTH="78%"><b>Description</b></td>
79
80<td VALIGN=TOP WIDTH="10%"><b>Required</b></td>
81</tr>
82
83<tr>
84<td VALIGN=TOP WIDTH="12%">repository</td>
85
86<td VALIGN=TOP WIDTH="78%">The location of the repository (see your PVCS
87manuals)</td>
88
89<td VALIGN=TOP WIDTH="10%">Yes</td>
90</tr>
91
92<tr>
93<td VALIGN=TOP WIDTH="12%">pvcsproject</td>
94
95<td VALIGN=TOP WIDTH="78%">The project within the PVCS repository to extract
96files from (&quot;/&quot; is root project and that is default if this attribute isn't
97specified)</td>
98
99<td VALIGN=TOP WIDTH="10%">No</td>
100</tr>
101
102<tr>
103<td VALIGN=TOP WIDTH="12%">label</td>
104
105<td VALIGN=TOP WIDTH="78%">Only files marked with this label are extracted.</td>
106
107<td VALIGN=TOP WIDTH="10%">No</td>
108</tr>
109
110<tr>
111<td VALIGN=TOP WIDTH="12%">promotiongroup</td>
112
113<td VALIGN=TOP WIDTH="78%">Only files within this promotion group are extracted. Using
114both the <i>label</i> and the <i>promotiongroup</i> tag will cause the files in the
115promotion group and with that label to be extracted.
116</td>
117
118<td VALIGN=TOP WIDTH="10%">No</td>
119</tr>
120
121<tr>
122<td VALIGN=TOP WIDTH="12%">config</td>
123
124<td VALIGN=TOP WIDTH="78%">path of a non default .cfg file.
125Can be given absolute or relative to ant's base directory.
126</td>
127
128<td VALIGN=TOP WIDTH="10%">No</td>
129</tr>
130
131<tr>
132<td VALIGN=TOP WIDTH="12%">force</td>
133
134<td VALIGN=TOP WIDTH="78%">If set to <i>yes</i> all files that exists and are writable are overwritten. Default <i>no</i> causes the files that are writable to be ignored. This stops the PVCS command <i>get</i> to stop asking questions!</td>
135
136<td VALIGN=TOP WIDTH="10%">No</td>
137</tr>
138
139<tr>
140<td VALIGN=TOP WIDTH="12%">workspace</td>
141
142<td VALIGN=TOP WIDTH="78%">By specifying a workspace, the files are extracted to that location. A PVCS workspace is a
143name for a location of the workfiles and isn't as such the location itself. You define the location for a workspace
144using the PVCS GUI clients. If this isn't specified the default workspace for the current user is used.</td>
145
146<td VALIGN=TOP WIDTH="10%">No</td>
147</tr>
148
149<tr>
150<td VALIGN=TOP WIDTH="12%">pvcsbin</td>
151
152<td VALIGN=TOP WIDTH="78%">On some systems the PVCS executables <i>pcli</i>
153and <i>get</i> are not found in the PATH. In such cases this attribute
154should be set to the bin directory of the PVCS installation containing
155the executables mentioned before. If this attribute isn't specified the
156tag expects the executables to be found using the PATH environment variable.</td>
157
158<td VALIGN=TOP WIDTH="10%">No</td>
159</tr>
160 <tr>
161 <td VALIGN=TOP WIDTH="12%">ignorereturncode</td>
162 <td VALIGN=TOP WIDTH="78%">If set to <i>true</i> the return value from executing
163 the pvcs commands are ignored.</td>
164 <td VALIGN=TOP WIDTH="10%">No</td>
165 </tr>
166 <tr>
167 <td VALIGN=TOP WIDTH="12%">updateonly</td>
168 <td VALIGN=TOP WIDTH="78%">If set to <i>true</i> files are gotten only if
169 newer than existing local files.</td>
170 <td VALIGN=TOP WIDTH="10%">No</td>
171 </tr>
172 <tr>
173 <td valign="TOP">filenameformat</td>
174 <td valign="TOP">The format of your folder names in a
175 format suitable for <code>java.text.MessageFormat</code>.
176 Defaults to <code>{0}-arc({1})</code>. Repositories where
177 the archive extension is not <code>-arc</code> should set
178 this.</td>
179 <td valign="TOP">No</td>
180 </tr>
181 <tr>
182 <td valign="TOP">linestart</td>
183 <td valign="TOP">Used to parse the output of the pcli
184 command. It defaults to <code>&quot;P:</code>. The parser already
185 knows about / and \\, this property is useful in cases where the
186 repository is accessed on a Windows platform via a drive letter
187 mapping.</td>
188 <td valign="TOP">No</td>
189 </tr>
190 <tr>
191 <td valign="TOP">revision</td>
192 <td valign="TOP">Retrieve the specified revision.</td>
193 <td valign="TOP">No</td>
194 </tr>
195 <tr>
196 <td valign="TOP">userid</td>
197 <td valign="TOP">Use the specified userid.</td>
198 <td valign="TOP">No</td>
199 </tr>
200</table>
201<h3><a name="nested">Nested Elements</a></h3>
202
203<h3>pvcsproject element</h3>
204<p><code>pvcs</code> supports a nested
205<code>&lt;pvcsproject&gt;</code> element, that represents a project
206within the PVCS repository to extract files from. By nesting multiple
207<code>&lt;pvcsproject&gt;</code> elements under the
208<code>&lt;pvcs&gt;</code> task, multiple projects can be
209specified.</p>
210
211<h3>Parameters</h3>
212
213<table BORDER CELLSPACING=0 CELLPADDING=2 >
214<tr>
215<td VALIGN=TOP WIDTH="12%"><b>Attribute</b></td>
216
217<td VALIGN=TOP WIDTH="78%"><b>Description</b></td>
218
219<td VALIGN=TOP WIDTH="10%"><b>Required</b></td>
220</tr>
221
222<tr>
223<td VALIGN=TOP WIDTH="12%">name</td>
224
225<td VALIGN=TOP WIDTH="78%">The name of the pvcs project</td>
226
227<td VALIGN=TOP WIDTH="10%">Yes</td>
228</tr>
229</table>
230
231<h3>Examples</h3>
232The following set-up extracts the latest version of the files in the pvcs repository.
233<pre>
234 &lt;!-- =================================================================== --&gt;
235 &lt;!-- Get the latest version --&gt;
236 &lt;!-- =================================================================== --&gt;
237 &lt;target name=&quot;getlatest&quot;&gt;
238 &lt;pvcs repository=&quot;/mnt/pvcs&quot; pvcsproject=&quot;/myprj&quot;/&gt;
239 &lt;/target&gt;</ul>
240</pre>
241<p>Now run:</p>
242<code>ant getlatest</code>
243<p>This will cause the following output to appear:</p>
244<pre>
245 getlatest:
246 [pvcs] PVCS Version Manager (VMGUI) v6.6.10 (Build 870) for Windows NT/80x86
247 [pvcs] Copyright 1985-2000 MERANT. All rights reserved.
248 [pvcs] PVCS Version Manager (get) v6.6.10 (Build 870) for Windows NT/80x86
249 [pvcs] Copyright 1985-2000 MERANT. All rights reserved.
250 [pvcs] c:\myws\myprj\main.java &lt;- C:\mypvcs\archives\myprj\main.java-arc
251 [pvcs] rev 1.1
252 [pvcs] c:\myws\myprj\apache\tool.java &lt;- C:\mypvcs\archives\myprj\apache\tools.java-arc
253 [pvcs] rev 1.5
254
255 BUILD SUCCESSFUL
256
257 Total time: 19 seconds</pre>
258
259This next example extracts the latest version of the files in the pvcs
260repository from two projects using nested <code>&lt;pvcsproject&gt;</code> elements.
261<pre>
262 &lt;!-- ===================================================================--&gt;
263 &lt;!-- Get latest from myprj and myprj2 --&gt;
264 &lt;!-- ===================================================================--&gt;
265 &lt;target name=&quot;getlatest2&quot;&gt;
266 &lt;pvcs repository=&quot;/mnt/pvcs&quot;&gt;
267 &lt;pvcsproject name=&quot;/myprj&quot;/&gt;
268 &lt;pvcsproject name=&quot;/myprj2&quot;/&gt;
269 &lt;/pvcs&gt;
270 &lt;/target&gt;</ul>
271</pre>
272<p>Now run:</p>
273<code>ant getlatest2</code>
274<p>This will cause the following output to appear:</p>
275<pre>
276 getlatest2:
277 [pvcs] PVCS Version Manager (VMGUI) v6.6.10 (Build 870) for Windows NT/80x86
278 [pvcs] Copyright 1985-2000 MERANT. All rights reserved.
279 [pvcs] PVCS Version Manager (get) v6.6.10 (Build 870) for Windows NT/80x86
280 [pvcs] Copyright 1985-2000 MERANT. All rights reserved.
281 [pvcs] c:\myws\myprj\main.java &lt;- C:\mypvcs\archives\myprj\main.java-arc
282 [pvcs] rev 1.1
283 [pvcs] c:\myws\myprj\apache\tool.java &lt;- C:\mypvcs\archives\myprj\apache\tool.java-arc
284 [pvcs] rev 1.5
285 [pvcs] c:\myws\myprj2\apache\tool2.java &lt;- C:\mypvcs\archives\myprj2\apache\tool2.java-arc
286 [pvcs] rev 1.2
287
288 BUILD SUCCESSFUL
289
290 Total time: 22 seconds</pre>
291
292<hr WIDTH="100%">
293<p>PVCS is a registered trademark of MERANT.</p>
294</body>
295</html>
Note: See TracBrowser for help on using the repository browser.