1
<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
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>
11
Ant Pvcs Task User Manual</h1>
13
<br><!-- Names are in alphabetical order, on last name -->
15
<li>Thomas Christensen (<a href="mailto:tchristensen@nordija.com">tchristensen@nordija.com</a>)</li>
16
<li>Don Jeffery (<a href="mailto:donj@apogeenet.com">donj@apogeenet.com</a>)</li>
18
Version 1.1 - 2001/06/27<br>
19
<p>Problems with UNC pathnames and the use of () in paths are fixed and an updateonly
20
argument introduced.</p>
21
Version 1.0 - 2001/01/31<br>
22
<p>Initial release.</p>
25
Table of Contents</h2>
29
<a href="#introduction">Introduction</a></li>
32
<a href="#configuretask">Pvcs Task</a></li>
37
<a NAME="introduction"></a>Introduction</h2>
38
The <pvcs> task allows the user of ant to extract the latest edition
39
of the source code from a PVCS repository. PVCS is a version control system
40
developed by <a href="http://www.merant.com/products/pvcs">Merant</a>.
42
Before using this tag, the user running ant must have access to the commands
43
of PVCS (get and pcli) and must have access to the repository. Note that the way to specify
44
the repository is platform dependent so use property to specify location of repository.
46
This version has been tested agains PVCS version 6.5 and 6.6 under Windows and Solaris.
50
<a NAME="pvcs"></a>Pvcs Task</h2>
54
The pvcs task is set to point at a PVCS repository and optionally a project
55
within that repository, and can from that specification get the latest
56
version of the files contained by the repository.
60
<table BORDER CELLSPACING=0 CELLPADDING=2 >
62
<td VALIGN=TOP WIDTH="12%"><b>Attribute</b></td>
64
<td VALIGN=TOP WIDTH="78%"><b>Description</b></td>
66
<td VALIGN=TOP WIDTH="10%"><b>Required</b></td>
70
<td VALIGN=TOP WIDTH="12%">repository</td>
72
<td VALIGN=TOP WIDTH="78%">The location of the repository (see your PVCS
75
<td VALIGN=TOP WIDTH="10%">Yes</td>
79
<td VALIGN=TOP WIDTH="12%">pvcsproject</td>
81
<td VALIGN=TOP WIDTH="78%">The project within the PVCS repository to extract
82
files from ("/" is root project and that is default if this attribute isn't
85
<td VALIGN=TOP WIDTH="10%">No</td>
89
<td VALIGN=TOP WIDTH="12%">label</td>
91
<td VALIGN=TOP WIDTH="78%">Only files marked with this label are extracted.</td>
93
<td VALIGN=TOP WIDTH="10%">No</td>
97
<td VALIGN=TOP WIDTH="12%">promotiongroup</td>
99
<td VALIGN=TOP WIDTH="78%">Only files within this promotion group are extracted. Using
100
both the <i>label</i> and the <i>promotiongroup</i> tag will cause the files in the
101
promotion group and with that label to be extracted.
104
<td VALIGN=TOP WIDTH="10%">No</td>
108
<td VALIGN=TOP WIDTH="12%">force</td>
110
<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>
112
<td VALIGN=TOP WIDTH="10%">No</td>
116
<td VALIGN=TOP WIDTH="12%">workspace</td>
118
<td VALIGN=TOP WIDTH="78%">By specifying a workspace, the files are extracted to that location. A PVCS workspace is a
119
name for a location of the workfiles and isn't as such the location itself. You define the location for a workspace
120
using the PVCS GUI clients. If this isn't specified the default workspace for the current user is used.</td>
122
<td VALIGN=TOP WIDTH="10%">No</td>
126
<td VALIGN=TOP WIDTH="12%">pvcsbin</td>
128
<td VALIGN=TOP WIDTH="78%">On some systems the PVCS executables <i>pcli</i>
129
and <i>get</i> are not found in the PATH. In such cases this attribute
130
should be set to the bin directory of the PVCS installation containing
131
the executables mentioned before. If this attribute isn't specified the
132
tag expects the executables to be found using the PATH environment variable.</td>
134
<td VALIGN=TOP WIDTH="10%">No</td>
137
<td VALIGN=TOP WIDTH="12%">ignorereturncode</td>
138
<td VALIGN=TOP WIDTH="78%">If set to <i>true</i> the return value from executing
139
the pvcs commands are ignored.</td>
140
<td VALIGN=TOP WIDTH="10%">No</td>
143
<td VALIGN=TOP WIDTH="12%">updateonly</td>
144
<td VALIGN=TOP WIDTH="78%">If set to <i>true</i> files are gotten only if
145
newer than existing local files.</td>
146
<td VALIGN=TOP WIDTH="10%">No</td>
149
<h3><a name="nested">Nested Elements</a></h3>
151
<h3>pvcsproject element</h3>
152
<p><code>pvcs</code> supports a nested
153
<code><pvcsproject></code> element, that represents a project
154
within the PVCS repository to extract files from. By nesting multiple
155
<code><pvcsproject></code> elements under the
156
<code><pvcs></code> task, multiple projects can be
161
<table BORDER CELLSPACING=0 CELLPADDING=2 >
163
<td VALIGN=TOP WIDTH="12%"><b>Attribute</b></td>
165
<td VALIGN=TOP WIDTH="78%"><b>Description</b></td>
167
<td VALIGN=TOP WIDTH="10%"><b>Required</b></td>
171
<td VALIGN=TOP WIDTH="12%">name</td>
173
<td VALIGN=TOP WIDTH="78%">The name of the pvcs project</td>
175
<td VALIGN=TOP WIDTH="10%">Yes</td>
181
The following set-up extracts the latest version of the files in the pvcs
183
<ul> <!-- ===================================================================
185
<br> <!-- Get the latest version
187
<br> <!-- ===================================================================
189
<br> <target name="getlatest">
190
<br> < pvcs repository="/mnt/pvcs"
191
pvcsproject="/myprj"/>
192
<br> </target></ul>
194
<p> ant getlatest
195
<p>This will cause the following output to appear:
196
<pre> getlatest:
197
[pvcs] PVCS Version Manager (VMGUI) v6.6.10 (Build 870) for Windows NT/80x86
198
[pvcs] Copyright 1985-2000 MERANT. All rights reserved.
199
[pvcs] PVCS Version Manager (get) v6.6.10 (Build 870) for Windows NT/80x86
200
[pvcs] Copyright 1985-2000 MERANT. All rights reserved.
201
[pvcs] c:\myws\myprj\main.java <- C:\mypvcs\archives\myprj\main.java-arc
202
[pvcs] rev 1.1
203
[pvcs] c:\myws\myprj\apache\tool.java <- C:\mypvcs\archives\myprj\apache\tools.java-arc
204
[pvcs] rev 1.5
206
BUILD SUCCESSFUL
208
Total time: 19 seconds</pre>
210
This next example extracts the latest version of the files in the pvcs
211
repository from two projects using nested <pvcsproject> elements.
212
<ul> <!-- ===================================================================
214
<br> <!-- Get latest from myprj and myprj2
216
<br> <!-- ===================================================================
218
<br> <target name="getlatest2">
219
<br> <pvcs repository="/mnt/pvcs">
220
<br> <pvcsproject name="/myprj" />
221
<br> <pvcsproject name="/myprj2" />
222
<br> </pvcs>
223
<br> </target></ul>
225
<p> ant getlatest2
226
<p>This will cause the following output to appear:
227
<pre> getlatest2:
228
[pvcs] PVCS Version Manager (VMGUI) v6.6.10 (Build 870) for Windows NT/80x86
229
[pvcs] Copyright 1985-2000 MERANT. All rights reserved.
230
[pvcs] PVCS Version Manager (get) v6.6.10 (Build 870) for Windows NT/80x86
231
[pvcs] Copyright 1985-2000 MERANT. All rights reserved.
232
[pvcs] c:\myws\myprj\main.java <- C:\mypvcs\archives\myprj\main.java-arc
233
[pvcs] rev 1.1
234
[pvcs] c:\myws\myprj\apache\tool.java <- C:\mypvcs\archives\myprj\apache\tool.java-arc
235
[pvcs] rev 1.5
236
[pvcs] c:\myws\myprj2\apache\tool2.java <- C:\mypvcs\archives\myprj2\apache\tool2.java-arc
237
[pvcs] rev 1.2
239
BUILD SUCCESSFUL
241
Total time: 22 seconds</pre>
246
<hr WIDTH="100%"></ul>
247
PVCS is a registered trademark of MERANT.
added
removed
docs/manual/OptionalTasks/pvcstask.html
