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