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

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

initial import of LiRK3
File size: 23.8 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<html>
18<head>
19<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
20<title>Microsoft Visual SourceSafe(VSS) Tasks</title>
21</head>
22<body>
23<h1>Microsoft Visual SourceSafe Tasks User Manual</h1>
24<p>by</p>
25<ul>
26 <li>Craig Cottingham</li>
27 <li>Andrew Everitt</li>
28 <li>Balazs Fejes 2</li>
29 <li><a href="mailto:[email protected]">[email protected]</a></li>
30 <li>Martin Poeschl (<a href="mailto:[email protected]">[email protected]</a>)</li>
31 <li>Phillip Wells</li>
32 <li>Jon Skeet (<a href="mailto:[email protected]">[email protected]</a>)</li>
33 <li>Nigel Magnay (<a href="mailto:[email protected]">[email protected]</a>)</li>
34 <li>Gary S. Weaver</li>
35 <li>Jesse Stockall</li>
36 </ul>
37<hr>
38<h2>Contents</h2>
39<ul>
40 <li><a href="#intro">Introduction</a></li>
41 <li><a href="#tasks">The Tasks</a></li>
42</ul>
43<br>
44<h2><a name="intro">Introduction</a></h2>
45<p>These tasks provide an interface to the
46<a href="http://msdn.microsoft.com/ssafe/default.asp" target="_top">Microsoft Visual SourceSafe</a> SCM.
47The <code>org.apache.tools.ant.taskdefs.optional.vss</code> package consists of a simple framework to support
48vss functionality as well as some Ant tasks encapsulating frequently used vss commands.
49Although it is possible to use these commands on the desktop,
50they were primarily intended to be used by automated build systems.</p>
51<p>
52If you get a CreateProcesss IOError=2 when running these, it means
53that ss.exe was not found. Check to see if you can run it from the
54command line -you may need to alter your path, or set the <tt>ssdir</tt>
55property.
56<h2><a name="tasks">The Tasks</a></h2>
57
58<table border="0" cellspacing="0" cellpadding="3">
59 <tr>
60 <td><a href="#vssget">vssget</a></td>
61 <td>Retrieves a copy of the specified VSS file(s).</td>
62 </tr>
63 <tr>
64 <td><a href="#vsslabel">vsslabel</a></td>
65 <td>Assigns a label to the specified version or current version of a file or project.</td>
66 </tr>
67 <tr>
68 <td><a href="#vsshistory">vsshistory</a></td>
69 <td>Shows the history of a file or project in VSS.</td>
70 </tr>
71 <tr>
72 <td><a href="#vsscheckin">vsscheckin</a></td>
73 <td>Updates VSS with changes made to a checked out file, and unlocks the VSS master copy.</td>
74 </tr>
75 <tr>
76 <td><a href="#vsscheckout">vsscheckout</a></td>
77 <td>Copies a file from the current project to the current folder, for the purpose of editing.</td>
78 </tr>
79 <tr>
80 <td><a href="#vssadd">vssadd</a></td>
81 <td>Adds a new file into the VSS Archive</td>
82 </tr>
83 <tr>
84 <td><a href="#vsscp">vsscp</a></td>
85 <td>Change the current project being used in VSS</td>
86 </tr>
87 <tr>
88 <td><a href="#vsscreate">vsscreate</a></td>
89 <td>Creates a project in VSS.</td>
90 </tr>
91</table>
92
93<hr>
94<h2>Task Descriptions</h2>
95
96<!-- VSSGET -->
97
98<h2><a name="vssget">VssGet</a></h2>
99<h3>Description</h3>
100Task to perform GET commands to Microsoft Visual SourceSafe.
101<p>If you specify two or more attributes from version, date and
102label only one will be used in the order version, date, label.</p>
103<h3>Parameters</h3>
104<table border="1" cellpadding="2" cellspacing="0">
105 <tr>
106 <td><b>Attribute</b></td>
107 <td><b>Values</b></td>
108 <td><b>Required</b></td>
109 </tr>
110 <tr>
111 <td>vsspath</td>
112 <td>SourceSafe path which specifies the project/file(s) you wish to
113 perform the action on.</td>
114 <td>Yes</td>
115 </tr>
116 <tr>
117 <td>login</td>
118 <td>username[,password] - The username and password needed to get access
119 to VSS. Note that you may need to specify both (if you have a password) -
120 Ant/VSS will hang if you leave the password out and VSS does not accept
121 login without a password. </td>
122 <td>No</td>
123 </tr>
124 <tr>
125 <td>localpath</td>
126 <td>Override the working directory and get to the specified path</td>
127 <td>No</td>
128 </tr>
129 <tr>
130 <td>ssdir</td>
131 <td>directory where <code>ss.exe</code> resides. By default the
132 task expects it to be in the PATH.</td>
133 <td>No</td>
134 </tr>
135 <tr>
136 <td>serverPath</td>
137 <td>directory where <code>srcsafe.ini</code> resides.</td>
138 <td>No</td>
139 </tr>
140 <tr>
141 <td>writable</td>
142 <td>true or false; default false</td>
143 <td>No</td>
144 </tr>
145 <tr>
146 <td>recursive</td>
147 <td>true or false; default false. Note however that in the SourceSafe UI
148 , there is a setting accessed via Tools/Options/GeneralTab called
149 &quot;Act on projects recursively&quot;. If this setting is checked,
150 then the recursive attribute is effectively ignored, and the get
151 will always be done recursively
152 </td>
153 <td>No</td>
154 </tr>
155 <tr>
156 <td>version</td>
157 <td>a version number to get</td>
158 <td rowspan="3">No, only one of these allowed</td>
159 </tr>
160 <tr>
161 <td>date</td>
162 <td>a date stamp to get at</td>
163 </tr>
164 <tr>
165 <td>label</td>
166 <td>a label to get for</td>
167 </tr>
168 <tr>
169 <td>quiet</td>
170 <td>suppress output (off by default)</td>
171 <td>No</td>
172 </tr>
173 <tr>
174 <td>autoresponse</td>
175 <td>What to respond with (sets the -I option). By default, -I- is
176 used; values of Y or N will be appended to this.</td>
177 <td>No</td>
178 </tr>
179 <tr>
180 <td>writablefiles</td>
181 <td>Behavior when local files are writable. Valid options are: <code>replace</code>,
182 <code>skip</code> and <code>fail</code>; Defaults to <code>fail</code>
183 <br><code>skip</code> implies <code>failonerror=false</code></td>
184 <td>No</td>
185 </tr>
186 <tr>
187 <td>failonerror</td>
188 <td>Stop the buildprocess if ss.exe exits with a returncode of 100. Defaults to true</td>
189 <td>No</td>
190 </tr>
191 <tr>
192 <td>filetimestamp</td>
193 <td>Set the behavior for timestamps of local files. Valid options are <code>current</code>,
194 <code>modified</code>, or <code>updated</code>. Defaults to <code>current</code>.</td>
195 <td>No</td>
196 </tr>
197</table>
198<p>Note that only one of version, date or label should be specified</p>
199<h3>Examples</h3>
200<blockquote>
201<pre>
202&lt;vssget localPath=&quot;C:\mysrc\myproject&quot;
203 recursive=&quot;true&quot;
204 label=&quot;Release1&quot;
205 login=&quot;me,mypassword&quot;
206 vsspath=&quot;$/source/aProject&quot;
207 writable=&quot;true&quot;/&gt;
208</pre>
209</blockquote>
210<p>Does a get on the VSS-Project <i>$/source/myproject</i> using the username
211<i>me</i> and the password <i>mypassword</i>. It will recursively get the files
212which are labeled <i>Release1</i> and write them to the local directory
213<i>C:\mysrc\myproject</i>. The local files will be writable.</p>
214<hr>
215
216<!-- VSSLABEL -->
217
218<h2><a name="vsslabel">VssLabel</a></h2>
219<h3>Description</h3>
220Task to perform LABEL commands to Microsoft Visual SourceSafe.
221<p>Assigns a label to the specified version or current version of a file or
222project.</p>
223<h3>Parameters</h3>
224<table border="1" cellpadding="2" cellspacing="0">
225 <tr>
226 <td><b>Attribute</b></td>
227 <td><b>Values</b></td>
228 <td><b>Required</b></td>
229 </tr>
230 <tr>
231 <td>vsspath</td>
232 <td>SourceSafe path which specifies the project/file(s) you wish to
233 perform the action on.</td>
234 <td>Yes</td>
235 </tr>
236 <tr>
237 <td>login</td>
238 <td>username[,password] - The username and password needed to get access
239 to VSS. Note that you may need to specify both (if you have a password) -
240 Ant/VSS will hang if you leave the password out and VSS does not accept
241 login without a password. </td>
242 <td>No</td>
243 </tr>
244 <tr>
245 <td>ssdir</td>
246 <td>directory where <code>ss.exe</code> resides. By default the
247 task expects it to be in the PATH.</td>
248 <td>No</td>
249 </tr>
250 <tr>
251 <td>serverPath</td>
252 <td>directory where <code>srcsafe.ini</code> resides.</td>
253 <td>No</td>
254 </tr>
255 <tr>
256 <td>label</td>
257 <td>A label to apply to the hierarchy</td>
258 <td>Yes</td>
259 </tr>
260 <tr>
261 <td>version</td>
262 <td>An existing file or project version to label. By default the current
263 version is labeled.</td>
264 <td>No</td>
265 </tr>
266 <tr>
267 <td>comment</td>
268 <td>The comment to use for this label. Empty or '-' for no comment.</td>
269 <td>No</td>
270 </tr>
271 <tr>
272 <td>autoresponse</td>
273 <td>What to respond with (sets the -I option). By default, -I- is
274 used; values of Y or N will be appended to this.</td>
275 <td>No</td>
276 </tr>
277 <tr>
278 <td>failonerror</td>
279 <td>Stop the buildprocess if ss.exe exits with a returncode of 100. Defaults to true</td>
280 <td>No</td>
281 </tr>
282</table>
283<h3>Examples</h3>
284<blockquote>
285<pre>
286&lt;vsslabel vsspath=&quot;$/source/aProject&quot;
287 login=&quot;me,mypassword&quot;
288 label=&quot;Release1&quot;/&gt;
289</pre>
290</blockquote>
291<p>Labels the current version of the VSS project <i>$/source/aProject</i> with
292the label <i>Release1</i> using the username <i>me</i> and the password
293<i>mypassword</i>.
294</p>
295<blockquote>
296<pre>
297&lt;vsslabel vsspath=&quot;$/source/aProject/myfile.txt&quot;
298 version=&quot;4&quot;
299 label=&quot;1.03.004&quot;/&gt;
300</pre>
301</blockquote>
302<p>Labels version 4 of the VSS file <i>$/source/aProject/myfile.txt</i> with the
303label <i>1.03.004</i>. If this version already has a label, the operation (and
304the build) will fail.
305</p>
306<hr>
307
308<!-- VSSHISTORY -->
309
310<h2><a name="vsshistory">VssHistory</a></h2>
311<h3>Description</h3>
312Task to perform HISTORY commands to Microsoft Visual SourceSafe.
313<h3>Parameters</h3>
314<table border="1" cellpadding="2" cellspacing="0">
315 <tr>
316 <td><b>Attribute</b></td>
317 <td><b>Values</b></td>
318 <td><b>Required</b></td>
319 </tr>
320 <tr>
321 <td>vsspath</td>
322 <td>SourceSafe path which specifies the project/file(s) you wish to
323 perform the action on.</td>
324 <td>Yes</td>
325 </tr>
326 <tr>
327 <td>login</td>
328 <td>username[,password] - The username and password needed to get access
329 to VSS. Note that you may need to specify both (if you have a password) -
330 Ant/VSS will hang if you leave the password out and VSS does not accept
331 login without a password. </td>
332 <td>No</td>
333 </tr>
334 <tr>
335 <td>ssdir</td>
336 <td>directory where <code>ss.exe</code> resides. By default the
337 task expects it to be in the PATH.</td>
338 <td>No</td>
339 </tr>
340 <tr>
341 <td>serverPath</td>
342 <td>directory where <code>srcsafe.ini</code> resides.</td>
343 <td>No</td>
344 </tr>
345 <tr>
346 <td>fromDate</td>
347 <td>Start date for comparison</td>
348 <td>See below</td>
349 </tr>
350 <tr>
351 <td>toDate</td>
352 <td>End date for comparison</td>
353 <td>See below</td>
354 </tr>
355 <tr>
356 <td>dateFormat</td>
357 <td>Format of dates in fromDate and toDate. Used when calculating dates with
358 the numdays attribute. This string uses the formatting rules of SimpleDateFormat.
359 Defaults to DateFormat.SHORT.</td>
360 <td>No</td>
361 </tr>
362 <tr>
363 <td>fromLabel</td>
364 <td>Start label for comparison</td>
365 <td>No</td>
366 </tr>
367 <tr>
368 <td>toLabel</td>
369 <td>Start label for comparison</td>
370 <td>No</td>
371 </tr>
372 <tr>
373 <td>numdays</td>
374 <td>The number of days for comparison.</td>
375 <td>See below</td>
376 </tr>
377 <tr>
378 <td>output</td>
379 <td>File to write the diff.</td>
380 <td>No</td>
381 </tr>
382 <tr>
383 <td>recursive</td>
384 <td>true or false</td>
385 <td>No</td>
386 </tr>
387 <tr>
388 <td>style</td>
389 <td>brief, codediff, default or nofile. The default is default.</td>
390 <td>No</td>
391 </tr>
392 <tr>
393 <td>user</td>
394 <td>Name the user whose changes we would like to see</td>
395 <td>No</td>
396 </tr>
397 <tr>
398 <td>failonerror</td>
399 <td>Stop the buildprocess if ss.exe exits with a returncode of 100. Defaults to true</td>
400 <td>No</td>
401 </tr>
402</table>
403
404<h4>Specifying the time-frame</h4>
405<p>There are different ways to specify what time-frame you wish to evaluate:</p>
406<ul>
407 <li>Changes between two dates: Specify both <code>fromDate</code> and <code>toDate</code> </li>
408 <li>Changes before a date: Specify <code>toDate</code></li>
409 <li>Changes after a date: Specify <code>fromDate</code></li>
410 <li>Changes X Days before a date: Specify <code>toDate</code> and (negative!) <code>numDays</code></li>
411 <li>Changes X Days after a date: Specify <code>fromDate</code> and <code>numDays</code></li>
412</ul>
413
414
415<h3>Examples</h3>
416<blockquote>
417 <pre>
418&lt;vsshistory vsspath=&quot;$/myProject&quot; recursive=&quot;true&quot;
419 fromLabel=&quot;Release1&quot;
420 toLabel=&quot;Release2&quot;/&gt;
421</pre>
422</blockquote>
423<p>Shows all changes between &quot;Release1&quot; and &quot;Release2&quot;.</p>
424
425<blockquote>
426 <pre>
427&lt;vsshistory vsspath=&quot;$/myProject&quot; recursive=&quot;true&quot;
428 fromDate=&quot;01.01.2001&quot;
429 toDate=&quot;31.03.2001&quot;/&gt;
430</pre>
431</blockquote>
432<p>Shows all changes between January 1st 2001 and March 31st 2001 (in Germany, date must be specified according to your locale).</p>
433
434<blockquote>
435 <pre>
436&lt;tstamp&gt;
437 &lt;format property=&quot;to.tstamp&quot; pattern=&quot;M-d-yy;h:mma&quot;/&gt;
438&lt;/tstamp&gt;
439
440&lt;vsshistory vsspath=&quot;$/myProject&quot; recursive=&quot;true&quot;
441 numDays=&quot;-14&quot;
442 dateFormat=&quot;M-d-yy;h:mma&quot;
443 toDate=&quot;${to.tstamp}&quot;/&gt;
444</pre>
445</blockquote>
446<p>Shows all changes in the 14 days before today.</p>
447<hr>
448
449<!-- VSSCHECKIN -->
450
451<h2><a name="vsscheckin">VssCheckin</a></h2>
452<h3>Description</h3>
453Task to perform CHECKIN commands to Microsoft Visual SourceSafe.
454<h3>Parameters</h3>
455<table border="1" cellpadding="2" cellspacing="0">
456 <tr>
457 <td><b>Attribute</b></td>
458 <td><b>Values</b></td>
459 <td><b>Required</b></td>
460 </tr>
461 <tr>
462 <td>vsspath</td>
463 <td>SourceSafe path which specifies the project/file(s) you wish to
464 perform the action on.</td>
465 <td>Yes</td>
466 </tr>
467 <tr>
468 <td>login</td>
469 <td>username[,password] - The username and password needed to get access
470 to VSS. Note that you may need to specify both (if you have a password) -
471 Ant/VSS will hang if you leave the password out and VSS does not accept
472 login without a password. </td>
473 <td>No</td>
474 </tr>
475 <tr>
476 <td>localpath</td>
477 <td>Override the working directory and get to the specified path</td>
478 <td>No</td>
479 </tr>
480 <tr>
481 <td>ssdir</td>
482 <td>directory where <code>ss.exe</code> resides. By default the
483 task expects it to be in the PATH.</td>
484 <td>No</td>
485 </tr>
486 <tr>
487 <td>serverPath</td>
488 <td>directory where <code>srcsafe.ini</code> resides.</td>
489 <td>No</td>
490 </tr>
491 <tr>
492 <td>writable</td>
493 <td>true or false</td>
494 <td>No</td>
495 </tr>
496 <tr>
497 <td>recursive</td>
498 <td>true or false</td>
499 <td>No</td>
500 </tr>
501 <tr>
502 <td>comment</td>
503 <td>Comment to use for the files that where checked in.</td>
504 <td>No</td>
505 </tr>
506 <tr>
507 <td>autoresponse</td>
508 <td>'Y', 'N' or empty. Specify how to reply to questions from VSS.</td>
509 <td>No</td>
510 </tr>
511 <tr>
512 <td>failonerror</td>
513 <td>Stop the buildprocess if ss.exe exits with a returncode of 100. Defaults to true</td>
514 <td>No</td>
515 </tr>
516</table>
517
518<h3>Examples</h3>
519<blockquote>
520<pre>
521&lt;vsscheckin vsspath=&quot;$/test/test*&quot;
522 localpath=&quot;D:\build\&quot;
523 comment=&quot;Modified by automatic build&quot;/&gt;
524</pre>
525</blockquote>
526<p>Checks in the file(s) named <i>test*</i> in the project <i>$/test</i> using
527the local directory <i>D:\build</i>.</p>
528<hr>
529
530<!-- VSSCHECKOUT -->
531
532<h2><a name="vsscheckout">VssCheckout</a></h2>
533<h3>Description</h3>
534Task to perform CHECKOUT commands to Microsoft Visual SourceSafe.
535<p>If you specify two or more attributes from version, date and
536label only one will be used in the order version, date, label.</p>
537<h3>Parameters</h3>
538<table border="1" cellpadding="2" cellspacing="0">
539 <tr>
540 <td><b>Attribute</b></td>
541 <td><b>Values</b></td>
542 <td><b>Required</b></td>
543 </tr>
544 <tr>
545 <td>vsspath</td>
546 <td>SourceSafe path which specifies the project/file(s) you wish to
547 perform the action on.</td>
548 <td>Yes</td>
549 </tr>
550 <tr>
551 <td>login</td>
552 <td>username[,password] - The username and password needed to get access
553 to VSS. Note that you may need to specify both (if you have a password) -
554 Ant/VSS will hang if you leave the password out and VSS does not accept
555 login without a password. </td>
556 <td>No</td>
557 </tr>
558 <tr>
559 <td>localpath</td>
560 <td>Override the working directory and get to the specified path</td>
561 <td>No</td>
562 </tr>
563 <tr>
564 <td>ssdir</td>
565 <td>directory where <code>ss.exe</code> resides. By default the
566 task expects it to be in the PATH.</td>
567 <td>No</td>
568 </tr>
569 <tr>
570 <td>serverPath</td>
571 <td>directory where <code>srcsafe.ini</code> resides.</td>
572 <td>No</td>
573 </tr>
574 <tr>
575 <td>writable</td>
576 <td>true or false</td>
577 <td>No</td>
578 </tr>
579 <tr>
580 <td>recursive</td>
581 <td>true or false</td>
582 <td>No</td>
583 </tr>
584 <tr>
585 <td>version</td>
586 <td>a version number to get</td>
587 <td rowspan="3">No, only one of these allowed</td>
588 </tr>
589 <tr>
590 <td>date</td>
591 <td>a date stamp to get at</td>
592 </tr>
593 <tr>
594 <td>label</td>
595 <td>a label to get for</td>
596 </tr>
597 <tr>
598 <td>writablefiles</td>
599 <td>Behavior when local files are writable. Valid options are: <code>replace</code>,
600 <code>skip</code> and <code>fail</code>; Defaults to <code>fail</code>
601 <br><code>skip</code> implies <code>failonerror=false</code></td>
602 <td>No</td>
603 </tr>
604 <tr>
605 <td>failonerror</td>
606 <td>Stop the buildprocess if ss.exe exits with a returncode of 100. Defaults to true</td>
607 <td>No</td>
608 </tr>
609 <tr>
610 <td>filetimestamp</td>
611 <td>Set the behavior for timestamps of local files. Valid options are <code>current</code>,
612 <code>modified</code>, or <code>updated</code>. Defaults to <code>current</code>.</td>
613 <td>No</td>
614 </tr>
615 <tr>
616 <td>getlocalcopy</td>
617 <td>Set the behavior to retrieve local copies of the files. Defaults to true.</td>
618 <td>No</td>
619 </tr>
620</table>
621
622<h3>Examples</h3>
623<blockquote>
624<pre>
625&lt;vsscheckout vsspath=&quot;$/test&quot;
626 localpath=&quot;D:\build&quot;
627 recursive=&quot;true&quot;
628 login=&quot;me,mypass&quot;/&gt;
629</pre>
630</blockquote>
631<p>Does a recursive checkout of the project <i>$/test</i> to the directory D:\build.
632</p>
633<hr>
634
635<!-- VSSADD -->
636
637<h2><a name="vssadd">VssAdd</a></h2>
638<h3>Description</h3>
639Task to perform ADD commands to Microsoft Visual SourceSafe.
640<h3>Parameters</h3>
641<table border="1" cellpadding="2" cellspacing="0">
642 <tr>
643 <td><b>Attribute</b></td>
644 <td><b>Values</b></td>
645 <td><b>Required</b></td>
646 </tr>
647 <tr>
648 <td>localpath</td>
649 <td>Specify the local file(s) to add to VSS</td>
650 <td>Yes</td>
651 </tr>
652 <tr>
653 <td>login</td>
654 <td>username[,password] - The username and password needed to get access
655 to VSS. Note that you may need to specify both (if you have a password) -
656 Ant/VSS will hang if you leave the password out and VSS does not accept
657 login without a password. </td>
658 <td>No</td>
659 </tr>
660 <tr>
661 <td>ssdir</td>
662 <td>directory where <code>ss.exe</code> resides. By default the
663 task expects it to be in the PATH.</td>
664 <td>No</td>
665 </tr>
666 <tr>
667 <td>serverPath</td>
668 <td>directory where <code>srcsafe.ini</code> resides.</td>
669 <td>No</td>
670 </tr>
671 <tr>
672 <td>writable</td>
673 <td>true or false</td>
674 <td>No</td>
675 </tr>
676 <tr>
677 <td>recursive</td>
678 <td>true or false</td>
679 <td>No</td>
680 </tr>
681 <tr>
682 <td>comment</td>
683 <td>Comment to use for the files that where checked in.</td>
684 <td>No</td>
685 </tr>
686 <tr>
687 <td>autoresponse</td>
688 <td>'Y', 'N' or empty. Specify how to reply to questions from VSS.</td>
689 <td>No</td>
690 </tr>
691 <tr>
692 <td>failonerror</td>
693 <td>Stop the buildprocess if ss.exe exits with a returncode of 100. Defaults to true</td>
694 <td>No</td>
695 </tr>
696</table>
697
698<h3>Examples</h3>
699<blockquote>
700<pre>
701&lt;vssadd localpath=&quot;D:\build\build.00012.zip&quot;
702 comment=&quot;Added by automatic build&quot;/&gt;
703</pre>
704</blockquote>
705<p>Add the file named build.00012.zip into the project current working
706directory (see vsscp).</p>
707<hr>
708
709<!-- VSSCP -->
710
711<h2><a name="vsscp">VssCp</a></h2>
712<h3>Description</h3>
713<p>Task to perform CP (Change Project) commands to Microsoft Visual SourceSafe.</p>
714<p>This task is typically used before a VssAdd in order to set the target project</p>
715<h3>Parameters</h3>
716<table border="1" cellpadding="2" cellspacing="0">
717 <tr>
718 <td><b>Attribute</b></td>
719 <td><b>Values</b></td>
720 <td><b>Required</b></td>
721 </tr>
722 <tr>
723 <td>vsspath</td>
724 <td>SourceSafe path which specifies the project you wish to
725 make the current project.</td>
726 <td>Yes</td>
727 </tr>
728 <tr>
729 <td>login</td>
730 <td>username[,password] - The username and password needed to get access
731 to VSS. Note that you may need to specify both (if you have a password) -
732 Ant/VSS will hang if you leave the password out and VSS does not accept
733 login without a password. </td>
734 <td>No</td>
735 </tr>
736 <tr>
737 <td>ssdir</td>
738 <td>directory where <code>ss.exe</code> resides. By default the
739 task expects it to be in the PATH.</td>
740 <td>No</td>
741 </tr>
742 <tr>
743 <td>serverPath</td>
744 <td>directory where <code>srcsafe.ini</code> resides.</td>
745 <td>No</td>
746 </tr>
747 <tr>
748 <td>failonerror</td>
749 <td>Stop the buildprocess if ss.exe exits with a returncode of 100. Defaults to true</td>
750 <td>No</td>
751 </tr>
752</table>
753
754<h3>Examples</h3>
755<blockquote>
756<pre>
757&lt;vsscp vsspath=&quot;$/Projects/ant&quot;/&gt;
758</pre>
759</blockquote>
760<p>Sets the current VSS project to <i>$/Projects/ant</i>.</p>
761<hr>
762
763<!-- VSSCREATE -->
764
765 <h2><a name="vsscreate">VssCreate</a></h2>
766 <h3>Description</h3>
767 Task to perform CREATE commands to Microsoft Visual Source Safe.
768 <p>Creates a new project in VSS.</p>
769<h3>Parameters</h3>
770<table border="1" cellpadding="2" cellspacing="0">
771 <tr>
772 <td><b>Attribute</b></td>
773 <td><b>Values</b></td>
774 <td><b>Required</b></td>
775 </tr>
776 <tr>
777 <td>login</td>
778 <td>username,password</td>
779 <td>No</td>
780 </tr>
781 <tr>
782 <td>vsspath</td>
783 <td>SourceSafe path of project to be created</td>
784 <td>Yes</td>
785 </tr>
786 <tr>
787 <td>ssdir</td>
788 <td>directory where <code>ss.exe</code> resides. By default the task expects it to be in the PATH.</td>
789 <td>No</td>
790 </tr>
791 <tr>
792 <td>quiet</td>
793 <td>suppress output (off by default)</td>
794 <td>No</td>
795 </tr>
796 <tr>
797 <td>failOnError</td>
798 <td>fail if there is an error creating the project (true by default)</td>
799 <td>No</td>
800 </tr>
801 <tr>
802 <td>autoresponse</td>
803 <td>What to respond with (sets the -I option). By default, -I- is used; values of Y or N will be appended to this.</td>
804 <td>No</td>
805 </tr>
806 <tr>
807 <td>comment</td>
808 <td>The comment to use for this label. Empty or '-' for no comment.</td>
809 <td>No</td>
810 </tr>
811</table>
812<h3>Examples</h3>
813<blockquote>
814<pre>
815&lt;vsscreate vsspath=&quot;$/existingProject/newProject&quot;/&gt;
816</pre>
817</blockquote>
818<p>Creates the VSS-Project <i>$/existingProject/newProject</i>.</p>
819<hr>
820
821<!-- Footer -->
822</body>
823</html>
Note: See TracBrowser for help on using the repository browser.