source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/docs/manual/OptionalTasks/pvcstask.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago

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