From 2678f50fe74a2c18323745f85984a0e5d03ff363 Mon Sep 17 00:00:00 2001 From: Stephane Bailliez Date: Fri, 1 Feb 2002 00:02:24 +0000 Subject: [PATCH] Updated documentation for SOS Submitted by: jesse@cryptocard.com (Jess Stockall) Best thanks to Erik. git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@271028 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/OptionalTasks/sos.html | 395 ++++++++++++++--------------- 1 file changed, 194 insertions(+), 201 deletions(-) diff --git a/docs/manual/OptionalTasks/sos.html b/docs/manual/OptionalTasks/sos.html index 9c252958a..7c6ef1538 100644 --- a/docs/manual/OptionalTasks/sos.html +++ b/docs/manual/OptionalTasks/sos.html @@ -1,91 +1,90 @@ + - + Ant User Manual - + - -
+ +

SourceOffSite Tasks User Manual

- -
by
-
- + +
by - Version 1.1 2002/01/23
-
- -
+Version 1.1 2002/01/23 +
+
+ +

Contents

- + -
- +
+

Introduction

- -

These tasks provide an interface to the - Microsoft Visual SourceSafe SCM via - SourceGear's SourceOffSite - product. SourceOffSite is an add-on to Microsoft's VSS, that -allows remote development teams and tele-commuters that need -fast and secure read/write access to a centralized SourceSafe - database via any TCP/IP connection . SOS also provides Linux & Solaris -clients. The org.apache.tools.ant.taskdefs.optional.sos - package consists of a simple framework to support SOS functionality as well + +

These tasks provide an interface to the +Microsoft Visual SourceSafe SCM via +SourceGear's SourceOffSite +product. SourceOffSite is an add-on to Microsoft's VSS, that allows remote +development teams and tele-commuters that need fast and secure read/write +access to a centralized SourceSafe database via any TCP/IP connection. SOS +provides Linux ,Solaris & Windows clients. The + org.apache.tools.ant.taskdefs.optional.sos +package consists of a simple framework to support SOS functionality as well as some Ant tasks encapsulating frequently used SOS commands. Although it is possible to use these commands on the desktop, they were primarily intended to be used by automated build systems. These tasks have been tested with -SourceOffSite version 3.5.1 connecting to VisualSourceSafe 6.0. The tasks -have been tested with Linux, Solaris & Windows2000

- +SourceOffSite version 3.5.1 connecting to VisualSourceSafe 6.0. The tasks +have been tested with Linux, Solaris & Windows2000.

+

The Tasks

- + - + - + - + + and unlocks the VSS master copy. - + + or file, locking the VSS master copy - - + +
sosget sosget Retrieves a read-only copy of the specified project or file.
soslabel soslabel Assigns a label to the specified project.
soscheckin soscheckin Updates VSS with changes made to a checked out file or project, - and unlocks the VSS master copy.
soscheckout soscheckout Retrieves a read-write copy of the specified project -or file, locking the VSS master copy

- -
+ +

Task Descriptions

- -

SOSGet
-

+ +

SOSGet
+

Description

- Task to perform GET commands from Microsoft Visual SourceSafe via SOS
+ Task to perform GET commands with SOS

Parameters

- + @@ -94,7 +93,7 @@ or file, locking the VSS master copy - + @@ -117,7 +116,7 @@ or file, locking the VSS master copy + If no file is specified then act upon the project @@ -141,7 +140,7 @@ or file, locking the VSS master copy - + @@ -169,43 +168,42 @@ or file, locking the VSS master copy - - + +
Required
soscmddirsoscmd Directory which contains soscmd(.exe)
soscmd(.exe) must be in the path if this is not specified		 No
file Filename to act upon
- If no file is specified then act upon the project		 No
No
nocompressionnocompress true or false - disable compression No
verbose true or false - Status messages are displayed No
- +

Example

-     <sosget    - verbose="true"
-                 -     recursive="true"
-                 -     login="build"
-                 -     pass="build"
-                 -     localpath="tmp"
-                 -     projectpath="/SourceRoot/project1"
-             -             sosserverpath="192.168.10.6:8888"
-                 -     vssserverpath="d:\vss\srcsafe.ini"/>
-   
- Connects to a SourceOffsite server on 192.168.10.6:8888 - with build,build as the username & password . The - SourceSafe database resides on the same box as the SOS server & the - VSS database is at "d:\vss\srcsafe.ini"
- Does a recursive GetProject on $/SourceRoot/project1 - , using tmp as the working directory.
-
- -
-

SOSLabel

- +    +<sosget   verbose="true"
+              +         recursive="true"
+              +         username="build"
+              +         password="build"
+              +         localpath="tmp"
+              +         projectpath="/SourceRoot/project1"
+              +         sosserverpath="192.168.10.6:8888"
+              +         vssserverpath="d:\vss\srcsafe.ini"/>

+ +Connects to a SourceOffsite server on 192.168.10.6:8888 with +build,build as the username & password. The SourceSafe database resides +on the same box as the SOS server & the VSS database is at +"d:\vss\srcsafe.ini" Does a recursive GetProject on $/SourceRoot/project1, +using tmp as the working directory.
+
+ +
+

SOSLabel

+

Description

- Task to perform Label commands from Microsoft Visual SourceSafe via SOS
+ Task to perform Label commands with SOS

Parameters

- + @@ -213,7 +211,7 @@ or file, locking the VSS master copy - + @@ -233,7 +231,7 @@ or file, locking the VSS master copy - + @@ -257,40 +255,42 @@ or file, locking the VSS master copy - - + +
Attribute Required
soscmddirsoscmd Directory which contains soscmd(.exe)
soscmd(.exe) must be in the path if this is not specified		 No SourceSafe project path without the "$" Yes
username SourceSafe username Yes verbose true or false - Status messages are displayed No
- +

Example

-     <soslabel    -   login="build"
-               -           pass="build"
-             -             label="test -label"
-             -             projectpath=" - /SourceRoot/project1 "
-             -             sosserverpath="192.168.10.6:8888"
-                 -         vssserverpath="d:\vss\srcsafe.ini"/>
-
- Connects to a SourceOffsite server on 192.168.10.6:8888 - with build,build as the username & password - . The SourceSafe database resides on the same box -as the SOS server & the VSS database is at "d:\vss\srcsafe.ini"
- Labels the $/SourceRoot/project1 project with - "test label".
-
- +    +<soslabel   username="build"
+             +             +password="build"
+             +             +label="test label"
+             +             +projectpath="/SourceRoot/project1
+             +             +sosserverpath="192.168.10.6:8888"
+             +             +vssserverpath="d:\vss\srcsafe.ini"/>

+ +Connects to a SourceOffsite server on 192.168.10.6:8888 with +build,build as the username & password. The SourceSafe database resides +on the same box as the SOS server & the VSS database is at +"d:\vss\srcsafe.ini". Labels the $/SourceRoot/project1 project with +"test label".
+
+

- -

SOSCheckIn

- + +

SOSCheckIn

+

Description

- Task to perform CheckIn commands from a Microsoft Visual Source Safe via SOS
+ Task to perform CheckIn commands with SOS

Parameters

@@ -300,7 +300,7 @@ as the SOS server & the VSS database is at "d:\vss\srcsafe.ini"Required - + @@ -346,7 +346,7 @@ as the SOS server & the VSS database is at "d:\vss\srcsafe.ini"No - + @@ -368,50 +368,51 @@ as the SOS server & the VSS database is at "d:\vss\srcsafe.ini"comment - - + +
soscmddirsoscmd Directory which contains soscmd(.exe)
soscmd(.exe) must be in the path if this is not specified		 No
nocompressionnocompress true or false - disable compression No
A comment to be applied to all files being checked in No
- +

Example

-     <soscheckin        -  login="build"
-             -                 -     pass="build"
-             -                 -     file="foobar.txt"
-                  -                verbose="true"
-                 -                 - comment="comment abc"
-             -                 -     projectpath="/SourceRoot/project1"
-             -                 -     sosserverpath="server1:8888"
-             -                 -     vssserverpath="\\server2\vss\srcsafe.ini"/>
-
- Connects to a SourceOffsite server on server1:8888 - with build,build as the username & password . - The SourceSafe database resides on a different box (server2)  - & the VSS database is on a share called "vss"
- Checks-in only the "foobar.txt" file adding a comment of "comment - abc" . Extra status messages will be displayed on screen.
-
- -
-

SOSCheckOut

- +    +<soscheckin   username="build"
+             +             +     password="build"
+             +             +     file="foobar.txt"
+             +             +     verbose="true"
+             +             +     comment="comment abc"
+             +             +     projectpath="/SourceRoot/project1"
+             +             +     sosserverpath="server1:8888"
+             +             +     vssserverpath="\\server2\vss\srcsafe.ini"/> +

+ +Connects to a SourceOffsite server on server1:8888 with build,build as +the username & password. The SourceSafe database resides on a different +box (server2) & the VSS database is on a share called "vss". Checks-in +only the "foobar.txt" file adding a comment of "comment abc". Extra status +messages will be displayed on screen.
+
+ +
+

SOSCheckOut

+

Description

- Task to perform CheckOut commands from a Microsoft Visual Source Safe via SOS
- + Task to perform CheckOut commands with SOS
+

Parameters

- + @@ -420,7 +421,7 @@ as the SOS server & the VSS database is at "d:\vss\srcsafe.ini"Required - + @@ -466,7 +467,7 @@ as the SOS server & the VSS database is at "d:\vss\srcsafe.ini"No - + @@ -484,48 +485,40 @@ as the SOS server & the VSS database is at "d:\vss\srcsafe.ini"verbose - - + +
soscmddirsoscmd Directory which contains soscmd(.exe)
soscmd(.exe) must be in the path if this is not specified		 No
nocompressionnocompress true or false - disable compression No
true or false - Status messages are displayed No

- +

Example

-     <soscheckout   soscmddir="/usr/bin"
-             -                 - verbose="true"
-             -                 - login="build"
-             -                 - pass="build"
-             -                 - ProjectPath=" /SourceRoot/project1"
-             -                 - sosserverpath="192.168.10.6:8888"
-             -                 - vssserverpath="\\server2\vss\srcsafe.ini"/>
-
- Connects to a SourceOffsite server on server1:8888 - with build,build as the username & password . - The SourceSafe database resides on a different box (server2)  - & the VSS database is on a share called "vss"
- Checks-out "project1" Only the "project1" directory - will be locked as the recursive option was not set. Extra status messages - will be displayed on screen. The soscmd(.exe) file to be - used resides in /usr/bin
-
- -

-
-
-
-
-
- +    +<soscheckout   soscmd="/usr/local/bin"
+             +             +       verbose="true"
+             +             +       username="build"
+             +             +       password="build"
+             +             +       projectpath="/SourceRoot/project1"
+             +             +       sosserverpath="192.168.10.6:8888"
+             +             +       vssserverpath="\\server2\vss\srcsafe.ini"/> +

+ +Connects to a SourceOffsite server on server1:8888 with build,build as +the username & password. The SourceSafe database resides on a different +box (server2) & the VSS database is on a share called "vss". Checks-out +"project1", Only the "project1" directory will be locked as the recursive +option was not set. Extra status messages will be displayed on screen. The +soscmd(.exe) file to be used resides in /usr/local/bin.
+