source: release-kits/lirk3/bin/ant-installer/web/manual1.6.2/manual/OptionalTasks/pvcstask.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

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