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