1 | <!--
|
---|
2 | Licensed to the Apache Software Foundation (ASF) under one or more
|
---|
3 | contributor license agreements. See the NOTICE file distributed with
|
---|
4 | this work for additional information regarding copyright ownership.
|
---|
5 | The ASF licenses this file to You under the Apache License, Version 2.0
|
---|
6 | (the "License"); you may not use this file except in compliance with
|
---|
7 | the License. You may obtain a copy of the License at
|
---|
8 |
|
---|
9 | http://www.apache.org/licenses/LICENSE-2.0
|
---|
10 |
|
---|
11 | Unless required by applicable law or agreed to in writing, software
|
---|
12 | distributed under the License is distributed on an "AS IS" BASIS,
|
---|
13 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
---|
14 | See the License for the specific language governing permissions and
|
---|
15 | limitations under the License.
|
---|
16 | -->
|
---|
17 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
---|
18 | <html>
|
---|
19 | <head>
|
---|
20 |
|
---|
21 | <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
|
---|
22 | <link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
---|
23 | <title>SOS Tasks</title>
|
---|
24 |
|
---|
25 | </head>
|
---|
26 | <body>
|
---|
27 |
|
---|
28 | <div align="center">
|
---|
29 | <h1>SourceOffSite Tasks User Manual</h1>
|
---|
30 |
|
---|
31 | <div align="left">by
|
---|
32 | <ul>
|
---|
33 | <li><a href="mailto:[email protected]">Jesse Stockall</a></li>
|
---|
34 | </ul>
|
---|
35 | Version 1.1 2002/01/23
|
---|
36 | <br>
|
---|
37 | <br>
|
---|
38 |
|
---|
39 | <hr width="100%" size="2">
|
---|
40 | <h2>Contents</h2>
|
---|
41 |
|
---|
42 | <ul>
|
---|
43 | <li><a href="#intro">Introduction</a></li>
|
---|
44 | <li><a href="#tasks">The Tasks</a></li>
|
---|
45 |
|
---|
46 | </ul>
|
---|
47 | <br>
|
---|
48 |
|
---|
49 | <h2><a name="intro">Introduction</a> </h2>
|
---|
50 |
|
---|
51 | <p>These tasks provide an interface to the <a href="http://msdn.microsoft.com/ssafe/default.asp" target="_top">
|
---|
52 | Microsoft Visual SourceSafe</a> SCM via <a href="http://www.sourcegear.com">
|
---|
53 | SourceGear's</a> <a href="http://sourcegear.com/sos/index.htm">SourceOffSite</a>
|
---|
54 | product. SourceOffSite is an add-on to Microsoft's VSS, that allows remote
|
---|
55 | development teams and tele-commuters that need fast and secure read/write
|
---|
56 | access to a centralized SourceSafe database via any TCP/IP connection. SOS
|
---|
57 | provides Linux ,Solaris & Windows clients. The
|
---|
58 | <code> org.apache.tools.ant.taskdefs.optional.sos</code>
|
---|
59 | package consists of a simple framework to support SOS functionality as well
|
---|
60 | as some Ant tasks encapsulating frequently used SOS commands. Although it
|
---|
61 | is possible to use these commands on the desktop, they were primarily intended
|
---|
62 | to be used by automated build systems. These tasks have been tested with
|
---|
63 | SourceOffSite version 3.5.1 connecting to VisualSourceSafe 6.0. The tasks
|
---|
64 | have been tested with Linux, Solaris & Windows2000.</p>
|
---|
65 |
|
---|
66 | <h2><a name="tasks">The Tasks</a> </h2>
|
---|
67 |
|
---|
68 | <table border="0" cellspacing="0" cellpadding="3">
|
---|
69 | <tbody>
|
---|
70 | <tr>
|
---|
71 | <td><a href="#SOSGet">sosget</a></td>
|
---|
72 | <td>Retrieves a read-only copy of the specified project or file.</td>
|
---|
73 | </tr>
|
---|
74 | <tr>
|
---|
75 | <td><a href="#SOSLabel">soslabel</a></td>
|
---|
76 | <td>Assigns a label to the specified project.</td>
|
---|
77 | </tr>
|
---|
78 | <tr>
|
---|
79 | <td><a href="#SOSCheckIn">soscheckin</a></td>
|
---|
80 | <td>Updates VSS with changes made to a checked out file or project,
|
---|
81 | and unlocks the VSS master copy.</td>
|
---|
82 | </tr>
|
---|
83 | <tr>
|
---|
84 | <td><a href="#SOSCheckOut">soscheckout</a></td>
|
---|
85 | <td>Retrieves a read-write copy of the specified project
|
---|
86 | or file, locking the VSS master copy</td>
|
---|
87 | </tr>
|
---|
88 |
|
---|
89 | </tbody>
|
---|
90 | </table>
|
---|
91 | <br>
|
---|
92 |
|
---|
93 | <hr width="100%" size="2">
|
---|
94 | <h2>Task Descriptions</h2>
|
---|
95 |
|
---|
96 | <h2><a name="SOSGet"></a>SOSGet<br>
|
---|
97 | </h2>
|
---|
98 | <h3>Description</h3>
|
---|
99 | Task to perform GET commands with SOS<br>
|
---|
100 | <h3>Parameters</h3>
|
---|
101 | </div>
|
---|
102 | </div>
|
---|
103 |
|
---|
104 | <table border="1" cellpadding="2" cellspacing="0">
|
---|
105 | <tbody>
|
---|
106 | <tr>
|
---|
107 | <td><b>Attribute</b></td>
|
---|
108 | <td><b>Values</b></td>
|
---|
109 | <td><b>Required</b></td>
|
---|
110 | </tr>
|
---|
111 | <tr>
|
---|
112 | <td>soscmd</td>
|
---|
113 | <td>Directory which contains soscmd(.exe) <br>
|
---|
114 | soscmd(.exe) must be in the path if this is not specified</td>
|
---|
115 | <td>No</td>
|
---|
116 | </tr>
|
---|
117 | <tr>
|
---|
118 | <td>vssserverpath</td>
|
---|
119 | <td>path to the srcsafe.ini - eg. \\server\vss\srcsafe.ini</td>
|
---|
120 | <td>Yes</td>
|
---|
121 | </tr>
|
---|
122 | <tr>
|
---|
123 | <td>sosserverpath</td>
|
---|
124 | <td>address & port of the SOS server - eg. 192.168.0.1:8888</td>
|
---|
125 | <td>Yes</td>
|
---|
126 | </tr>
|
---|
127 | <tr>
|
---|
128 | <td>projectpath</td>
|
---|
129 | <td>SourceSafe project path - eg. $/SourceRoot/Project1</td>
|
---|
130 | <td>Yes</td>
|
---|
131 | </tr>
|
---|
132 | <tr>
|
---|
133 | <td>file</td>
|
---|
134 | <td>Filename to act upon<br>
|
---|
135 | If no file is specified then act upon the project</td>
|
---|
136 | <td>No</td>
|
---|
137 | </tr>
|
---|
138 | <tr>
|
---|
139 | <td>username</td>
|
---|
140 | <td>SourceSafe username</td>
|
---|
141 | <td>Yes</td>
|
---|
142 | </tr>
|
---|
143 | <tr>
|
---|
144 | <td>password</td>
|
---|
145 | <td>SourceSafe password</td>
|
---|
146 | <td>No</td>
|
---|
147 | </tr>
|
---|
148 | <tr>
|
---|
149 | <td>localpath</td>
|
---|
150 | <td>Override the working directory and get to the specified path</td>
|
---|
151 | <td>No</td>
|
---|
152 | </tr>
|
---|
153 | <tr>
|
---|
154 | <td>soshome</td>
|
---|
155 | <td>The path to the SourceOffSite home directory</td>
|
---|
156 | <td>No</td>
|
---|
157 | </tr>
|
---|
158 | <tr>
|
---|
159 | <td>nocompress</td>
|
---|
160 | <td>true or false - disable compression</td>
|
---|
161 | <td>No</td>
|
---|
162 | </tr>
|
---|
163 | <tr>
|
---|
164 | <td>recursive</td>
|
---|
165 | <td>true or false - Only works with the GetProject command</td>
|
---|
166 | <td>No</td>
|
---|
167 | </tr>
|
---|
168 | <tr>
|
---|
169 | <td>version</td>
|
---|
170 | <td>a version number to get - Only works with the GetFile command</td>
|
---|
171 | <td>No</td>
|
---|
172 | </tr>
|
---|
173 | <tr>
|
---|
174 | <td>label</td>
|
---|
175 | <td>a label version to get - Only works with the GetProject command</td>
|
---|
176 | <td>No</td>
|
---|
177 | </tr>
|
---|
178 | <tr>
|
---|
179 | <td>nocache</td>
|
---|
180 | <td>true or false - Only needed if SOSHOME is set as an environment variable</td>
|
---|
181 | <td>No</td>
|
---|
182 | </tr>
|
---|
183 | <tr>
|
---|
184 | <td>verbose</td>
|
---|
185 | <td>true or false - Status messages are displayed</td>
|
---|
186 | <td>No</td>
|
---|
187 | </tr>
|
---|
188 | </tbody>
|
---|
189 | </table>
|
---|
190 |
|
---|
191 | <h3>Example</h3>
|
---|
192 |
|
---|
193 | <pre>
|
---|
194 | <sosget verbose="true"
|
---|
195 | recursive="true"
|
---|
196 | username="build"
|
---|
197 | password="build"
|
---|
198 | localpath="tmp"
|
---|
199 | projectpath="$/SourceRoot/project1"
|
---|
200 | sosserverpath="192.168.10.6:8888"
|
---|
201 | vssserverpath="d:\vss\srcsafe.ini"/>
|
---|
202 | </pre>
|
---|
203 | <small>Connects to a SourceOffsite server on 192.168.10.6:8888 with
|
---|
204 | build,build as the username & password. The SourceSafe database resides
|
---|
205 | on the same box as the SOS server & the VSS database is at
|
---|
206 | "d:\vss\srcsafe.ini" Does a recursive GetProject on
|
---|
207 | $/SourceRoot/project1, using tmp as the working
|
---|
208 | directory. </small><br>
|
---|
209 | <br>
|
---|
210 |
|
---|
211 | <hr width="100%" size="2">
|
---|
212 | <h2><a name="SOSLabel"></a>SOSLabel</h2>
|
---|
213 |
|
---|
214 | <h3>Description</h3>
|
---|
215 | Task to perform Label commands with SOS<br>
|
---|
216 | <h3>Parameters</h3>
|
---|
217 |
|
---|
218 | <table border="1" cellpadding="2" cellspacing="0">
|
---|
219 | <tbody><tr>
|
---|
220 | <td><b>Attribute</b></td>
|
---|
221 | <td><b>Values</b></td>
|
---|
222 | <td><b>Required</b></td>
|
---|
223 | </tr>
|
---|
224 | <tr>
|
---|
225 | <td>soscmd</td>
|
---|
226 | <td>Directory which contains soscmd(.exe) <br>
|
---|
227 | soscmd(.exe) must be in the path if this is not specified</td>
|
---|
228 | <td>No</td>
|
---|
229 | </tr>
|
---|
230 | <tr>
|
---|
231 | <td>vssserverpath</td>
|
---|
232 | <td>path to the srcsafe.ini - eg. \\server\vss\srcsafe.ini</td>
|
---|
233 | <td>Yes</td>
|
---|
234 | </tr>
|
---|
235 | <tr>
|
---|
236 | <td>sosserverpath</td>
|
---|
237 | <td>address and port of the SOS server - eg. 192.168.0.1:8888</td>
|
---|
238 | <td>Yes</td>
|
---|
239 | </tr>
|
---|
240 | <tr>
|
---|
241 | <td>projectpath</td>
|
---|
242 | <td>SourceSafe project path - eg. $/SourceRoot/Project1</td>
|
---|
243 | <td>Yes</td>
|
---|
244 | </tr>
|
---|
245 | <tr>
|
---|
246 | <td>username</td>
|
---|
247 | <td>SourceSafe username</td>
|
---|
248 | <td>Yes</td>
|
---|
249 | </tr>
|
---|
250 | <tr>
|
---|
251 | <td>password</td>
|
---|
252 | <td>SourceSafe password</td>
|
---|
253 | <td>No</td>
|
---|
254 | </tr>
|
---|
255 | <tr>
|
---|
256 | <td>label</td>
|
---|
257 | <td>The label to apply to a project</td>
|
---|
258 | <td>Yes</td>
|
---|
259 | </tr>
|
---|
260 | <tr>
|
---|
261 | <td>comment</td>
|
---|
262 | <td>A comment to be applied to all files being labeled</td>
|
---|
263 | <td>No</td>
|
---|
264 | </tr>
|
---|
265 | <tr>
|
---|
266 | <td>verbose</td>
|
---|
267 | <td>true or false - Status messages are displayed</td>
|
---|
268 | <td>No</td>
|
---|
269 | </tr>
|
---|
270 | </tbody>
|
---|
271 | </table>
|
---|
272 |
|
---|
273 | <h3>Example</h3>
|
---|
274 | <pre>
|
---|
275 | <soslabel username="build"
|
---|
276 | password="build"
|
---|
277 | label="test label"
|
---|
278 | projectpath="$/SourceRoot/project1"
|
---|
279 | sosserverpath="192.168.10.6:8888"
|
---|
280 | vssserverpath="d:\vss\srcsafe.ini"/>
|
---|
281 | </pre>
|
---|
282 |
|
---|
283 | <small>Connects to a SourceOffsite server on 192.168.10.6:8888 with
|
---|
284 | build,build as the username & password. The SourceSafe database resides
|
---|
285 | on the same box as the SOS server & the VSS database is at
|
---|
286 | "d:\vss\srcsafe.ini". Labels the $/SourceRoot/project1
|
---|
287 | project with "test label".</small><br>
|
---|
288 | <br>
|
---|
289 |
|
---|
290 | <hr width="100%" size="2"><br>
|
---|
291 |
|
---|
292 | <h2><a name="SOSCheckIn"></a>SOSCheckIn</h2>
|
---|
293 |
|
---|
294 | <h3>Description</h3>
|
---|
295 | Task to perform CheckIn commands with SOS<br>
|
---|
296 | <h3>Parameters</h3>
|
---|
297 | <table border="1" cellpadding="2" cellspacing="0">
|
---|
298 | <tbody>
|
---|
299 | <tr>
|
---|
300 | <td><b>Attribute</b></td>
|
---|
301 | <td><b>Values</b></td>
|
---|
302 | <td><b>Required</b></td>
|
---|
303 | </tr>
|
---|
304 | <tr>
|
---|
305 | <td>soscmd</td>
|
---|
306 | <td>Directory which contains soscmd(.exe) <br>
|
---|
307 | soscmd(.exe) must be in the path if this is not specified</td>
|
---|
308 | <td>No</td>
|
---|
309 | </tr>
|
---|
310 | <tr>
|
---|
311 | <td>vssserverpath</td>
|
---|
312 | <td>path to the srcsafe.ini - eg. \\server\vss\srcsafe.ini</td>
|
---|
313 | <td>Yes</td>
|
---|
314 | </tr>
|
---|
315 | <tr>
|
---|
316 | <td>sosserverpath</td>
|
---|
317 | <td>address and port of the SOS server - eg. 192.168.0.1:8888</td>
|
---|
318 | <td>Yes</td>
|
---|
319 | </tr>
|
---|
320 | <tr>
|
---|
321 | <td>projectpath</td>
|
---|
322 | <td>SourceSafe project path - eg. $/SourceRoot/Project1</td>
|
---|
323 | <td>Yes</td>
|
---|
324 | </tr>
|
---|
325 | <tr>
|
---|
326 | <td>file</td>
|
---|
327 | <td>Filename to act upon<br> If no file is specified then act upon the project</td>
|
---|
328 | <td>No</td>
|
---|
329 | </tr>
|
---|
330 | <tr>
|
---|
331 | <td>username</td>
|
---|
332 | <td>SourceSafe username</td>
|
---|
333 | <td>Yes</td>
|
---|
334 | </tr>
|
---|
335 | <tr>
|
---|
336 | <td>password</td>
|
---|
337 | <td>SourceSafe password</td>
|
---|
338 | <td>No</td>
|
---|
339 | </tr>
|
---|
340 | <tr>
|
---|
341 | <td>localpath</td>
|
---|
342 | <td>Override the working directory and get to the specified path</td>
|
---|
343 | <td>No</td>
|
---|
344 | </tr>
|
---|
345 | <tr>
|
---|
346 | <td>soshome</td>
|
---|
347 | <td>The path to the SourceOffSite home directory</td>
|
---|
348 | <td>No</td>
|
---|
349 | </tr>
|
---|
350 | <tr>
|
---|
351 | <td>nocompress</td>
|
---|
352 | <td>true or false - disable compression</td>
|
---|
353 | <td>No</td>
|
---|
354 | </tr>
|
---|
355 | <tr>
|
---|
356 | <td>recursive</td>
|
---|
357 | <td>true or false - Only works with the CheckOutProject command</td>
|
---|
358 | <td>No</td>
|
---|
359 | </tr>
|
---|
360 | <tr>
|
---|
361 | <td>nocache</td>
|
---|
362 | <td>true or false - Only needed if SOSHOME is set as an environment variable</td>
|
---|
363 | <td>No</td>
|
---|
364 | </tr>
|
---|
365 | <tr>
|
---|
366 | <td>verbose</td>
|
---|
367 | <td>true or false - Status messages are displayed</td>
|
---|
368 | <td>No</td>
|
---|
369 | </tr>
|
---|
370 | <tr><td>comment</td>
|
---|
371 | <td>A comment to be applied to all files being checked in</td>
|
---|
372 | <td>No</td>
|
---|
373 | </tr>
|
---|
374 | </tbody>
|
---|
375 | </table>
|
---|
376 |
|
---|
377 | <h3>Example</h3>
|
---|
378 | <pre>
|
---|
379 | <soscheckin username="build"
|
---|
380 | password="build"
|
---|
381 | file="foobar.txt"
|
---|
382 | verbose="true"
|
---|
383 | comment="comment abc"
|
---|
384 | projectpath="$/SourceRoot/project1"
|
---|
385 | sosserverpath="server1:8888"
|
---|
386 | vssserverpath="\\server2\vss\srcsafe.ini"/>
|
---|
387 | </pre>
|
---|
388 |
|
---|
389 | <small>Connects to a SourceOffsite server on server1:8888 with build,build as
|
---|
390 | the username & password. The SourceSafe database resides on a different
|
---|
391 | box (server2) & the VSS database is on a share called
|
---|
392 | "vss". Checks-in only the "foobar.txt" file adding
|
---|
393 | a comment of "comment abc". Extra status messages will be
|
---|
394 | displayed on screen.</small><br>
|
---|
395 | <br>
|
---|
396 |
|
---|
397 | <hr width="100%" size="2">
|
---|
398 | <h2><a name="SOSCheckOut"></a>SOSCheckOut</h2>
|
---|
399 |
|
---|
400 | <h3>Description</h3>
|
---|
401 | Task to perform CheckOut commands with SOS<br>
|
---|
402 |
|
---|
403 | <h3>Parameters</h3>
|
---|
404 |
|
---|
405 | <table border="1" cellpadding="2" cellspacing="0">
|
---|
406 | <tbody>
|
---|
407 | <tr>
|
---|
408 | <td><b>Attribute</b></td>
|
---|
409 | <td><b>Values</b></td>
|
---|
410 | <td><b>Required</b></td>
|
---|
411 | </tr>
|
---|
412 | <tr>
|
---|
413 | <td>soscmd</td>
|
---|
414 | <td>Directory which contains soscmd(.exe) <br>
|
---|
415 | soscmd(.exe) must be in the path if this is not specified</td>
|
---|
416 | <td>No</td>
|
---|
417 | </tr>
|
---|
418 | <tr>
|
---|
419 | <td>vssserverpath</td>
|
---|
420 | <td>path to the srcsafe.ini - eg. \\server\vss\srcsafe.ini</td>
|
---|
421 | <td>Yes</td>
|
---|
422 | </tr>
|
---|
423 | <tr>
|
---|
424 | <td>sosserverpath</td>
|
---|
425 | <td>address and port of the SOS server - eg. 192.168.0.1:8888</td>
|
---|
426 | <td>Yes</td>
|
---|
427 | </tr>
|
---|
428 | <tr>
|
---|
429 | <td>projectpath</td>
|
---|
430 | <td>SourceSafe project path - eg. $/SourceRoot/Project1</td>
|
---|
431 | <td>Yes</td>
|
---|
432 | </tr>
|
---|
433 | <tr>
|
---|
434 | <td>file</td>
|
---|
435 | <td>Filename to act upon<br> If no file is specified then act upon the project</td>
|
---|
436 | <td>No</td>
|
---|
437 | </tr>
|
---|
438 | <tr>
|
---|
439 | <td>username</td>
|
---|
440 | <td>SourceSafe username</td>
|
---|
441 | <td>Yes</td>
|
---|
442 | </tr>
|
---|
443 | <tr>
|
---|
444 | <td>password</td>
|
---|
445 | <td>SourceSafe password</td>
|
---|
446 | <td>No</td>
|
---|
447 | </tr>
|
---|
448 | <tr>
|
---|
449 | <td>localpath</td>
|
---|
450 | <td>Override the working directory and get to the specified path</td>
|
---|
451 | <td>No</td>
|
---|
452 | </tr>
|
---|
453 | <tr>
|
---|
454 | <td>soshome</td>
|
---|
455 | <td>The path to the SourceOffSite home directory</td>
|
---|
456 | <td>No</td>
|
---|
457 | </tr>
|
---|
458 | <tr>
|
---|
459 | <td>nocompress</td>
|
---|
460 | <td>true or false - disable compression</td>
|
---|
461 | <td>No</td>
|
---|
462 | </tr>
|
---|
463 | <tr>
|
---|
464 | <td>recursive</td>
|
---|
465 | <td>true or false - Only works with the CheckOutProject command</td>
|
---|
466 | <td>No</td>
|
---|
467 | </tr>
|
---|
468 | <tr>
|
---|
469 | <td>nocache</td>
|
---|
470 | <td>true or false - Only needed if SOSHOME is set as an environment variable</td>
|
---|
471 | <td>No</td>
|
---|
472 | </tr>
|
---|
473 | <tr>
|
---|
474 | <td>verbose</td>
|
---|
475 | <td>true or false - Status messages are displayed</td>
|
---|
476 | <td>No</td>
|
---|
477 | </tr>
|
---|
478 | </tbody>
|
---|
479 | </table>
|
---|
480 | <br>
|
---|
481 |
|
---|
482 | <h3>Example</h3>
|
---|
483 | <pre>
|
---|
484 | <soscheckout soscmd="/usr/local/bin"
|
---|
485 | verbose="true"
|
---|
486 | username="build"
|
---|
487 | password="build"
|
---|
488 | projectpath="$/SourceRoot/project1"
|
---|
489 | sosserverpath="192.168.10.6:8888"
|
---|
490 | vssserverpath="\\server2\vss\srcsafe.ini"/>
|
---|
491 | </pre>
|
---|
492 |
|
---|
493 | <small>Connects to a SourceOffsite server on server1:8888 with build,build as
|
---|
494 | the username & password. The SourceSafe database resides on a different
|
---|
495 | box (server2) & the VSS database is on a share called
|
---|
496 | "vss". Checks-out "project1", Only the
|
---|
497 | "project1" directory will be locked as the recursive option
|
---|
498 | was not set. Extra status messages will be displayed on screen. The
|
---|
499 | soscmd(.exe) file to be used resides in /usr/local/bin.</small><br>
|
---|
500 | <br>
|
---|
501 |
|
---|
502 | </body>
|
---|
503 | </html>
|
---|