You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

vss.html 24 kB

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