youys
/
ant
Not watched
1
0
Fork 1
Code
Releases 0 Wiki Activity
Issues 0 Pull Requests 0 Datasets Model Cloudbrain
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.
Tree: 0619a250bf
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '0619a250bf'
${ noResults }
ant/docs/manual/OptionalTasks/sos.html

489 lines
14 kB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

  2. <html>

  3. <head>

  4. 

  5.   <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">

  6.   <title>SOS Tasks</title>

  7. 

  8. </head>

  9. <body>

  10. 

  11. <div align="center">

  12. <h1>SourceOffSite Tasks User Manual</h1>

  13. 

  14. <div align="left">by

  15. <ul>

  16. <li><a href="mailto:jesse@cryptocard.com">Jesse Stockall</a></li>

  17. </ul>

  18. Version 1.1 2002/01/23

  19. <br>

  20. <br>

  21. 

  22. <hr width="100%" size="2">

  23. <h2>Contents</h2>

  24. 

  25. <ul>

  26.     <li><a href="#intro">Introduction</a></li>

  27.     <li><a href="#tasks">The Tasks</a></li>

  28. 

  29. </ul>

  30. <br>

  31. 

  32. <h2><a name="intro">Introduction</a> </h2>

  33. 

  34. <p>These tasks provide an interface to the <a href="http://msdn.microsoft.com/ssafe/default.asp" target="_top">

  35. Microsoft Visual SourceSafe</a> SCM via <a href="http://www.sourcegear.com">

  36. SourceGear's</a> <a href="http://sourcegear.com/sos/index.htm">SourceOffSite</a>

  37. product. SourceOffSite is an add-on to Microsoft's VSS, that allows remote

  38. development teams and tele-commuters that need fast and secure read/write

  39. access to a centralized SourceSafe database via any TCP/IP connection. SOS

  40. provides Linux ,Solaris &amp; Windows clients. The

  41. <code> org.apache.tools.ant.taskdefs.optional.sos</code>

  42. package consists  of a simple framework to support SOS functionality as well

  43. as some Ant tasks  encapsulating frequently used SOS commands.  Although it

  44. is possible to use  these commands on the desktop,  they were primarily intended

  45. to be used by  automated build systems. These tasks have been tested with

  46. SourceOffSite  version 3.5.1 connecting to VisualSourceSafe 6.0. The tasks

  47. have been tested with Linux, Solaris &amp; Windows2000.</p>

  48. 

  49. <h2><a name="tasks">The Tasks</a> </h2>

  50. 

  51. <table border="0" cellspacing="0" cellpadding="3">

  52.        <tbody>

  53.          <tr>

  54.            <td><a href="#SOSGet">sosget</a></td>

  55.            <td>Retrieves a read-only copy of the specified project or file.</td>

  56.          </tr>

  57.          <tr>

  58.            <td><a href="#SOSLabel">soslabel</a></td>

  59.            <td>Assigns a label to the specified project.</td>

  60.          </tr>

  61.          <tr>

  62.            <td><a href="#SOSCheckIn">soscheckin</a></td>

  63.            <td>Updates VSS with changes made to a checked out file or project,

  64.            and unlocks the VSS master copy.</td>

  65.          </tr>

  66.          <tr>

  67.            <td><a href="#SOSCheckOut">soscheckout</a></td>

  68.            <td>Retrieves a read-write copy of the specified project

  69.            or file, locking the&nbsp;VSS master copy</td>

  70.          </tr>

  71. 

  72.   </tbody>

  73. </table>

  74.      <br>

  75. 

  76. <hr width="100%" size="2">

  77. <h2>Task Descriptions</h2>

  78. 

  79. <h2><a name="SOSGet"></a>SOSGet<br>

  80.      </h2>

  81. <h3>Description</h3>

  82.              Task to perform GET commands with SOS<br>

  83. <h3>Parameters</h3>

  84.      </div>

  85.      </div>

  86. 

  87. <table border="1">

  88.      <tbody>

  89.        <tr>

  90.           <th>Attribute</th>

  91.           <th>Values</th>

  92.           <th>Required</th>

  93.         </tr>

  94.         <tr>

  95.           <td>soscmd</td>

  96.           <td>Directory which contains soscmd(.exe) <br>

  97.           soscmd(.exe) must be in the path if this is not specified</td>

  98.           <td>No</td>

  99.         </tr>

  100.         <tr>

  101.            <td>vssserverpath</td>

  102.            <td>path to the srcsafe.ini  - eg. \\server\vss\srcsafe.ini</td>

  103.            <td>Yes</td>

  104.         </tr>

  105.         <tr>

  106.            <td>sosserverpath</td>

  107.            <td>address &amp; port of the SOS server  - eg. 192.168.0.1:8888</td>

  108.            <td>Yes</td>

  109.         </tr>

  110.         <tr>

  111.            <td>projectpath</td>

  112.            <td>SourceSafe project path - eg. $/SourceRoot/Project1</td>

  113.            <td>Yes</td>

  114.         </tr>

  115.         <tr>

  116.            <td>file</td>

  117.            <td>Filename to act upon<br>

  118.            If no file is specified then act upon the project</td>

  119.            <td>No</td>

  120.         </tr>

  121.         <tr>

  122.            <td>username</td>

  123.            <td>SourceSafe username</td>

  124.            <td>Yes</td>

  125.         </tr>

  126.         <tr>

  127.            <td>password</td>

  128.            <td>SourceSafe password</td>

  129.            <td>No</td>

  130.         </tr>

  131.         <tr>

  132.            <td>localpath</td>

  133.            <td>Override the working directory and get to the specified path</td>

  134.            <td>No</td>

  135.         </tr>

  136.         <tr>

  137.            <td>soshome</td>

  138.            <td>The path to the SourceOffSite home directory</td>

  139.            <td>No</td>

  140.         </tr>

  141.         <tr>

  142.            <td>nocompress</td>

  143.            <td>true or false - disable compression</td>

  144.            <td>No</td>

  145.         </tr>

  146.         <tr>

  147.            <td>recursive</td>

  148.            <td>true or false - Only works with the GetProject command</td>

  149.            <td>No</td>

  150.         </tr>

  151.         <tr>

  152.            <td>version</td>

  153.            <td>a version number to get - Only works with the GetFile command</td>

  154.            <td>No</td>

  155.         </tr>

  156.         <tr>

  157.            <td>label</td>

  158.            <td>a label version to get - Only works with the GetProject command</td>

  159.            <td>No</td>

  160.         </tr>

  161.         <tr>

  162.            <td>nocache</td>

  163.            <td>true or false - Only needed if SOSHOME is set as an environment variable</td>

  164.            <td>No</td>

  165.         </tr>

  166.         <tr>

  167.            <td>verbose</td>

  168.            <td>true or false - Status messages are displayed</td>

  169.            <td>No</td>

  170.         </tr>

  171.   </tbody>

  172. </table>

  173. 

  174. <h3>Example</h3>

  175. 

  176. <pre>

  177. &lt;sosget verbose=&quot;true&quot;

  178.         recursive=&quot;true&quot;

  179.         username=&quot;build&quot;

  180.         password=&quot;build&quot;

  181.         localpath=&quot;tmp&quot;

  182.         projectpath=&quot;$/SourceRoot/project1&quot;

  183.         sosserverpath=&quot;192.168.10.6:8888&quot;

  184.         vssserverpath=&quot;d:\vss\srcsafe.ini&quot;/&gt;

  185. </pre>

  186. <small>Connects to a SourceOffsite server on 192.168.10.6:8888 with

  187. build,build as the username &amp; password. The SourceSafe  database resides

  188. on the same box as the SOS server  &amp; the VSS database  is at

  189. &quot;d:\vss\srcsafe.ini&quot; Does a recursive GetProject on

  190. $/SourceRoot/project1, using tmp as the working

  191. directory. </small><br>

  192. <br>

  193. 

  194. <hr width="100%" size="2">

  195. <h2><a name="SOSLabel"></a>SOSLabel</h2>

  196. 

  197. <h3>Description</h3>

  198.              Task to perform Label commands with SOS<br>

  199. <h3>Parameters</h3>

  200. 

  201. <table border="1">

  202.     <tbody><tr>

  203.       <th>Attribute</th>

  204.       <th>Values</th>

  205.       <th>Required</th>

  206.     </tr>

  207.     <tr>

  208.       <td>soscmd</td>

  209.       <td>Directory which contains soscmd(.exe) <br>

  210.       soscmd(.exe) must be in the path if this is not specified</td>

  211.       <td>No</td>

  212.     </tr>

  213.     <tr>

  214.        <td>vssserverpath</td>

  215.        <td>path to the srcsafe.ini  - eg. \\server\vss\srcsafe.ini</td>

  216.        <td>Yes</td>

  217.     </tr>

  218.     <tr>

  219.        <td>sosserverpath</td>

  220.        <td>address and port of the SOS server  - eg. 192.168.0.1:8888</td>

  221.        <td>Yes</td>

  222.     </tr>

  223.     <tr>

  224.        <td>projectpath</td>

  225.        <td>SourceSafe project path - eg. $/SourceRoot/Project1</td>

  226.        <td>Yes</td>

  227.     </tr>

  228.     <tr>

  229.        <td>username</td>

  230.        <td>SourceSafe username</td>

  231.        <td>Yes</td>

  232.     </tr>

  233.     <tr>

  234.        <td>password</td>

  235.        <td>SourceSafe password</td>

  236.        <td>No</td>

  237.     </tr>

  238.     <tr>

  239.        <td>label</td>

  240.        <td>The label to apply to a project</td>

  241.        <td>Yes</td>

  242.     </tr>

  243.     <tr>

  244.        <td>comment</td>

  245.        <td>A comment to be applied to all files being labeled</td>

  246.        <td>No</td>

  247.     </tr>

  248.     <tr>

  249.        <td>verbose</td>

  250.        <td>true or false - Status messages are displayed</td>

  251.        <td>No</td>

  252.     </tr>

  253.   </tbody>

  254. </table>

  255. 

  256. <h3>Example</h3>

  257. <pre>

  258. &lt;soslabel username=&quot;build&quot;

  259.           password=&quot;build&quot;

  260.           label=&quot;test label&quot;

  261.           projectpath=&quot;$/SourceRoot/project1&quot;

  262.           sosserverpath=&quot;192.168.10.6:8888&quot;

  263.           vssserverpath=&quot;d:\vss\srcsafe.ini&quot;/&gt;

  264. </pre>

  265. 

  266. <small>Connects to a SourceOffsite server on 192.168.10.6:8888 with

  267. build,build as the username &amp; password. The SourceSafe database resides

  268. on the same box as  the  SOS server  &amp; the VSS database is at

  269. &quot;d:\vss\srcsafe.ini&quot;. Labels the $/SourceRoot/project1

  270. project with &quot;test label&quot;.</small><br>

  271. <br>

  272. 

  273. <hr width="100%" size="2"><br>

  274. 

  275. <h2><a name="SOSCheckIn"></a>SOSCheckIn</h2>

  276. 

  277. <h3>Description</h3>

  278.         Task to perform CheckIn commands with SOS<br>

  279. <h3>Parameters</h3>

  280. <table border="1">

  281.        <tbody>

  282.     <tr>

  283.       <th>Attribute</th>

  284.       <th>Values</th>

  285.       <th>Required</th>

  286.     </tr>

  287.     <tr>

  288.       <td>soscmd</td>

  289.       <td>Directory which contains soscmd(.exe) <br>

  290.       soscmd(.exe) must be in the path if this is not specified</td>

  291.       <td>No</td>

  292.     </tr>

  293.     <tr>

  294.        <td>vssserverpath</td>

  295.        <td>path to the srcsafe.ini  - eg. \\server\vss\srcsafe.ini</td>

  296.        <td>Yes</td>

  297.     </tr>

  298.     <tr>

  299.        <td>sosserverpath</td>

  300.        <td>address and port of the SOS server  - eg. 192.168.0.1:8888</td>

  301.        <td>Yes</td>

  302.     </tr>

  303.     <tr>

  304.        <td>projectpath</td>

  305.        <td>SourceSafe project path - eg. $/SourceRoot/Project1</td>

  306.        <td>Yes</td>

  307.     </tr>

  308.     <tr>

  309.        <td>file</td>

  310.        <td>Filename to act upon<br> If no file is specified then act upon the project</td>

  311.        <td>No</td>

  312.     </tr>

  313.     <tr>

  314.        <td>username</td>

  315.        <td>SourceSafe username</td>

  316.        <td>Yes</td>

  317.     </tr>

  318.     <tr>

  319.        <td>password</td>

  320.        <td>SourceSafe password</td>

  321.        <td>No</td>

  322.     </tr>

  323.     <tr>

  324.        <td>localpath</td>

  325.        <td>Override the working directory and get to the specified path</td>

  326.        <td>No</td>

  327.     </tr>

  328.     <tr>

  329.        <td>soshome</td>

  330.        <td>The path to the SourceOffSite home directory</td>

  331.        <td>No</td>

  332.     </tr>

  333.     <tr>

  334.        <td>nocompress</td>

  335.        <td>true or false - disable compression</td>

  336.        <td>No</td>

  337.     </tr>

  338.     <tr>

  339.        <td>recursive</td>

  340.        <td>true or false - Only works with the CheckOutProject command</td>

  341.        <td>No</td>

  342.     </tr>

  343.     <tr>

  344.        <td>nocache</td>

  345.        <td>true or false - Only needed if SOSHOME is set as an environment variable</td>

  346.        <td>No</td>

  347.     </tr>

  348.     <tr>

  349.        <td>verbose</td>

  350.        <td>true or false - Status messages are displayed</td>

  351.        <td>No</td>

  352.     </tr>

  353.     <tr><td>comment</td>

  354.        <td>A comment to be applied to all files being checked in</td>

  355.        <td>No</td>

  356.     </tr>

  357.  </tbody>

  358. </table>

  359. 

  360. <h3>Example</h3>

  361. <pre>

  362. &lt;soscheckin username=&quot;build&quot;

  363.             password=&quot;build&quot;

  364.             file=&quot;foobar.txt&quot;

  365.             verbose=&quot;true&quot;

  366.             comment=&quot;comment abc&quot;

  367.             projectpath=&quot;$/SourceRoot/project1&quot;

  368.             sosserverpath=&quot;server1:8888&quot;

  369.             vssserverpath=&quot;\\server2\vss\srcsafe.ini&quot;/&gt;

  370. </pre>

  371. 

  372. <small>Connects to a SourceOffsite server on server1:8888 with build,build as

  373. the username &amp; password. The SourceSafe database resides on a different

  374. box (server2) &amp; the VSS database is on a share called

  375. &quot;vss&quot;. Checks-in only the &quot;foobar.txt&quot; file adding

  376. a comment of &quot;comment abc&quot;. Extra status messages will be

  377. displayed on screen.</small><br>

  378. <br>

  379. 

  380. <hr width="100%" size="2">

  381. <h2><a name="SOSCheckOut"></a>SOSCheckOut</h2>

  382. 

  383. <h3>Description</h3>

  384.        Task to perform CheckOut commands with SOS<br>

  385. 

  386. <h3>Parameters</h3>

  387. 

  388. <table border="1">

  389.        <tbody>

  390.     <tr>

  391.       <th>Attribute</th>

  392.       <th>Values</th>

  393.       <th>Required</th>

  394.     </tr>

  395.     <tr>

  396.       <td>soscmd</td>

  397.       <td>Directory which contains soscmd(.exe) <br>

  398.       soscmd(.exe) must be in the path if this is not specified</td>

  399.       <td>No</td>

  400.     </tr>

  401.     <tr>

  402.        <td>vssserverpath</td>

  403.        <td>path to the srcsafe.ini  - eg. \\server\vss\srcsafe.ini</td>

  404.        <td>Yes</td>

  405.     </tr>

  406.     <tr>

  407.        <td>sosserverpath</td>

  408.        <td>address and port of the SOS server  - eg. 192.168.0.1:8888</td>

  409.        <td>Yes</td>

  410.     </tr>

  411.     <tr>

  412.        <td>projectpath</td>

  413.        <td>SourceSafe project path - eg. $/SourceRoot/Project1</td>

  414.        <td>Yes</td>

  415.     </tr>

  416.     <tr>

  417.        <td>file</td>

  418.        <td>Filename to act upon<br> If no file is specified then act upon the project</td>

  419.        <td>No</td>

  420.     </tr>

  421.     <tr>

  422.        <td>username</td>

  423.        <td>SourceSafe username</td>

  424.        <td>Yes</td>

  425.     </tr>

  426.     <tr>

  427.        <td>password</td>

  428.        <td>SourceSafe password</td>

  429.        <td>No</td>

  430.     </tr>

  431.     <tr>

  432.        <td>localpath</td>

  433.        <td>Override the working directory and get to the specified path</td>

  434.        <td>No</td>

  435.     </tr>

  436.     <tr>

  437.        <td>soshome</td>

  438.        <td>The path to the SourceOffSite home directory</td>

  439.        <td>No</td>

  440.     </tr>

  441.     <tr>

  442.        <td>nocompress</td>

  443.        <td>true or false - disable compression</td>

  444.        <td>No</td>

  445.     </tr>

  446.     <tr>

  447.        <td>recursive</td>

  448.        <td>true or false - Only works with the CheckOutProject command</td>

  449.        <td>No</td>

  450.     </tr>

  451.     <tr>

  452.        <td>nocache</td>

  453.        <td>true or false - Only needed if SOSHOME is set as an environment variable</td>

  454.        <td>No</td>

  455.     </tr>

  456.     <tr>

  457.        <td>verbose</td>

  458.        <td>true or false - Status messages are displayed</td>

  459.        <td>No</td>

  460.     </tr>

  461.   </tbody>

  462. </table>

  463.      <br>

  464. 

  465. <h3>Example</h3>

  466. <pre>

  467. &lt;soscheckout soscmd=&quot;/usr/local/bin&quot;

  468.              verbose=&quot;true&quot;

  469.              username=&quot;build&quot;

  470.              password=&quot;build&quot;

  471.              projectpath=&quot;$/SourceRoot/project1&quot;

  472.              sosserverpath=&quot;192.168.10.6:8888&quot;

  473.              vssserverpath=&quot;\\server2\vss\srcsafe.ini&quot;/&gt;

  474. </pre>

  475. 

  476. <small>Connects to a SourceOffsite server on server1:8888 with build,build as

  477. the username &amp; password. The SourceSafe database resides on a different

  478. box (server2) &amp; the VSS database is on a share called

  479. &quot;vss&quot;. Checks-out &quot;project1&quot;, Only the

  480. &quot;project1&quot; directory will be locked as the recursive option

  481. was not set. Extra status messages will be displayed on screen. The

  482. soscmd(.exe) file to be used resides in /usr/local/bin.</small><br>

  483. <br>

  484. <hr>

  485. <p align="center">Copyright &copy; 2002 Apache Software Foundation. All rights

  486. Reserved.</p>

  487. </body>

  488. </html>