by
+2001/04/29
+These tasks provide an interface to the
+Microsoft Visual SourceSafe SCM.
+The org.apache.tools.ant.taskdefs.optional.vss package consists of a simple framework to support
+vss functionality as well as some Ant tasks encapsulating frequently used vss commands.
+Although it is possible to use these commands on the desktop,
+they were primarily intended to be used by automated build systems.
| vssget | +Retrieves a copy of the specified VSS file(s). | +
| vsslabel | +Assigns a label to the specified version or current version of a file or project. | +
| vsshistory | +Shows the history of a file or project in VSS. | +
| vsscheckin | +Updates VSS with changes made to a checked out file, and unlocks the VSS master copy. | +
| vsscheckout | +Copies a file from the current project to the current folder, for the purpose of editing. | +
If you specify two or more attributes from version, date and +label only one will be used in the order version, date, label.
+| Attribute | +Values | +Required | +
|---|---|---|
| vsspath | +SourceSafe path which specifies the project/file(s) you wish to + perform the action on. You should not specify the leading dollar-sign - + it is prepended by Ant automatically. | +Yes | +
| login | +username[,password] - The username and password needed to get access + to VSS. Note that you may need to specify both (if you have a password) - + Ant/VSS will hang if you leave the password out and VSS does not accept + login without a password. | +No | +
| localpath | +Override the working directory and get to the specified path | +No | +
| ssdir | +directory where ss.exe resides. By default the
+ task expects it to be in the PATH. |
+ No | +
| serverPath | +directory where srssafe.ini resides. |
+ No | +
| writable | +true or false | +No | +
| recursive | +true or false | +No | +
| version | +a version number to get | +No, only one of these allowed | +
| date | +a date stamp to get at | +|
| label | +a label to get for | +
Note that only one of version, date or label should be specified
++++<vssget localPath="C:\mysrc\myproject" + recursive="true" + label="Release1" + login="me,mypassword" + vsspath="/source/aProject" + writable="true"/> ++
Does a get on the VSS-Project $/source/myproject using the username +me and the password mypassword. It will recursively get the files +which are labeled Release1 and write them to the local directory +C:\mysrc\myproject. The local files will be writable.
+Assigns a label to the specified version or current version of a file or +project.
+| Attribute | +Values | +Required | +
|---|---|---|
| vsspath | +SourceSafe path which specifies the project/file(s) you wish to + perform the action on. You should not specify the leading dollar-sign - + it is prepended by Ant automatically. | +Yes | +
| login | +username[,password] - The username and password needed to get access + to VSS. Note that you may need to specify both (if you have a password) - + Ant/VSS will hang if you leave the password out and VSS does not accept + login without a password. | +No | +
| ssdir | +directory where ss.exe resides. By default the
+ task expects it to be in the PATH. |
+ No | +
| serverPath | +directory where srssafe.ini resides. |
+ No | +
| label | +A label to apply to the hierarchy | +Yes | +
| version | +An existing file or project version to label. By default the current + version is labelled. | +No | +
| comment | +The comment to use for this label. Empty or '-' for no comment. | +No | +
+++<vsslabel vsspath="/source/aProject" + login="me,mypassword" + label="Release1"/> ++
Labels the current version of the VSS project $/source/aProject with +the label Release1 using the username me and the password +mypassword. +
++++<vsslabel vsspath="/source/aProject/myfile.txt" + version="4" + label="1.03.004"/> ++
Labels version 4 of the VSS file $/source/aProject/myfile.txt with the +label 1.03.004. If this version already has a label, the operation (and +the build) will fail. +
+| Attribute | +Values | +Required | +
|---|---|---|
| vsspath | +SourceSafe path which specifies the project/file(s) you wish to + perform the action on. You should not specify the leading dollar-sign - + it is prepended by Ant automatically. | +Yes | +
| login | +username[,password] - The username and password needed to get access + to VSS. Note that you may need to specify both (if you have a password) - + Ant/VSS will hang if you leave the password out and VSS does not accept + login without a password. | +No | +
| ssdir | +directory where ss.exe resides. By default the
+ task expects it to be in the PATH. |
+ No | +
| serverPath | +directory where srssafe.ini resides. |
+ No | +
| fromDate | +Start date for comparison | +See below | +
| toDate | +Start date for comparison | +See below | +
| dateFormat | +Format of dates in fromDate and toDate. Used when calculating dates with + the numdays attribute. This string uses the formatting rules of SimpleDateFormat. + Defaults to DateFormat.SHORT. | +No | +
| fromLabel | +Start label for comparison | +No | +
| toLabel | +Start label for comparison | +No | +
| numdays | +The number of days for comparison. | +See below | +
| output | +File to write the diff. | +No | +
| recursive | +true or false | +No | +
| style | +brief, codediff, default or nofile. The default is default. | +No | +
There are different ways to specify what time-frame you wish to evaluate:
+fromDate and toDate toDatefromDatetoDate and (negative!) numDaysfromDate and numDays+++<vsshistory vsspath="/myProject" recursive="true" + fromLabel="Release1" + toLabel="Release2"/> ++
Shows all changes between "Release1" and "Release2".
+ ++++<vsshistory vsspath="/myProject" recursive="true" + fromDate="01.01.2001" + toDate="31.03.2001"/> ++
Shows all changes between January 1st 2001 and March 31st 2001 (in Germany, date must be specified according to your locale).
+ +
+
+<tstamp>
+ <format property="to.tstamp" pattern="M-d-yy;h:mma" />
+</tstamp>
+
+<vsshistory vsspath="/myProject" recursive="true"
+ numDays="-14"
+ dateFormat="M-d-yy;h:mma"
+ toDate="${to.tstamp}"/>
+
+
+Shows all changes in the 14 days before today.
+| Attribute | +Values | +Required | +
|---|---|---|
| vsspath | +SourceSafe path which specifies the project/file(s) you wish to + perform the action on. You should not specify the leading dollar-sign - + it is prepended by Ant automatically. | +Yes | +
| login | +username[,password] - The username and password needed to get access + to VSS. Note that you may need to specify both (if you have a password) - + Ant/VSS will hang if you leave the password out and VSS does not accept + login without a password. | +No | +
| localpath | +Override the working directory and get to the specified path | +No | +
| ssdir | +directory where ss.exe resides. By default the
+ task expects it to be in the PATH. |
+ No | +
| serverPath | +directory where srssafe.ini resides. |
+ No | +
| writable | +true or false | +No | +
| recursive | +true or false | +No | +
| comment | +Comment to use for the files that where checked in. | +No | +
| autoresponse | +'Y', 'N' or empty. Specify how to reply to questions from VSS. | +No | +
+++<vsscheckin vsspath="/test/test*" + localpath="D:\build\" + comment="Modified by automatic build"/> ++
Checks in the file(s) named test* in the project test using +the local directory D:\build.
+If you specify two or more attributes from version, date and +label only one will be used in the order version, date, label.
+| Attribute | +Values | +Required | +
|---|---|---|
| vsspath | +SourceSafe path which specifies the project/file(s) you wish to + perform the action on. You should not specify the leading dollar-sign - + it is prepended by Ant automatically. | +Yes | +
| login | +username[,password] - The username and password needed to get access + to VSS. Note that you may need to specify both (if you have a password) - + Ant/VSS will hang if you leave the password out and VSS does not accept + login without a password. | +No | +
| localpath | +Override the working directory and get to the specified path | +No | +
| ssdir | +directory where ss.exe resides. By default the
+ task expects it to be in the PATH. |
+ No | +
| serverPath | +directory where srssafe.ini resides. |
+ No | +
| writable | +true or false | +No | +
| recursive | +true or false | +No | +
| version | +a version number to get | +No, only one of these allowed | +
| date | +a date stamp to get at | +|
| label | +a label to get for | +
+++<vsscheckout vsspath="/test" + localpath="D:\build" + recursive="true" + login="me,mypass" + autoResponse="Y"/> ++
Does a recursive checkout of the project test to the directory D:\build. +This will overwrite all files already checked out (caused by autoResponse set to "Y"). +
+Copyright © 2000,2001 Apache Software Foundation. All rights +Reserved.
+ + diff --git a/docs/manual/OptionalTasks/vssget.html b/docs/manual/OptionalTasks/vssget.html deleted file mode 100644 index a0d7f39ed..000000000 --- a/docs/manual/OptionalTasks/vssget.html +++ /dev/null @@ -1,96 +0,0 @@ - - - - -If you specify two or more attributes from version, date and -label only one will be used in the order version, date, label.
-| Attribute | -Values | -Required | -
|---|---|---|
| login | -username,password | -No | -
| vsspath | -SourceSafe path | -Yes | -
| localpath | -Override the working directory and get to the specified path | -No | -
| writable | -true or false | -No | -
| recursive | -true or false | -No | -
| version | -a version number to get | -No | -
| date | -a date stamp to get at | -No | -
| label | -a label to get for | -No | -
| ssdir | -directory where ss.exe resides. By default the
- task expects it to be in the PATH. |
- No | -
| serverPath | -directory where srssafe.ini resides. |
- No | -
Note that only one of version, date or label should be specified
----<vssget localPath="C:\mysrc\myproject" - recursive="true" - label="Release1" - login="me,mypassword" - vsspath="/source/aProject" - writable="true"/> --
Does a get on the VSS-Project $/source/aproject using the username -me and the password mypassword. It will recursively get the files -which are labeled Release1 and write them to the local directory -C:\mysrc\myproject. The local files will be writable.
-Copyright © 2000,2001 Apache Software Foundation. All rights -Reserved.
- - - - diff --git a/docs/manual/OptionalTasks/vsshistory.html b/docs/manual/OptionalTasks/vsshistory.html deleted file mode 100644 index ad4e89437..000000000 --- a/docs/manual/OptionalTasks/vsshistory.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - -| Attribute | -Values | -Required | -
|---|---|---|
| login | -username,password | -No | -
| vsspath | -SourceSafe path | -Yes | -
| ssdir | -directory where ss.exe resides. By default the task
- expects it to be in the PATH. |
- No | -
| serverPath | -directory where srssafe.ini resides. |
- No | -
| fromDate | -Start date for comparison | -See below | -
| toDate | -Start date for comparison | -See below | -
| dateFormat | -Format of dates in fromDate and toDate. Used when calculating dates with - the numdays attribute. This string uses the formatting rules of SimpleDateFormat. - Defaults to DateFormat.SHORT. | -No | -
| fromLabel | -Start label for comparison | -No | -
| toLabel | -Start label for comparison | -No | -
| numdays | -The number of days for comparison. | -See below | -
| output | -File to write the diff. | -No | -
| recursive | -true or false | -No | -
| style | -brief, codediff, default or nofile. The default is default. | -No | -
There are different ways to specify what time-frame you wish to evaluate:
-fromDate and toDate toDatefromDatetoDate and (negative!) numDaysfromDate and numDays---<vsshistory vsspath="/myProject" recursive="true" - fromLabel="Release1" - toLabel="Release2"/> --
Shows all changes between "Release1" and "Release2".
- ----<vsshistory vsspath="/myProject" recursive="true" - fromDate="01.01.2001" - toDate="31.03.2001"/> --
Shows all changes between January 1st 2001 and March 31st 2001 (in Germany, date must be specified according to your locale).
- -
-
-<tstamp>
- <format property="to.tstamp" pattern="M-d-yy;h:mma" />
-</tstamp>
-
-<vsshistory vsspath="/myProject" recursive="true"
- numDays="-14"
- dateFormat="M-d-yy;h:mma"
- toDate="${to.tstamp}"/>
-
-
-Shows all changes in the 14 days before today.
- -Copyright © 2000,2001 Apache Software Foundation. All rights -Reserved.
- - - - diff --git a/docs/manual/OptionalTasks/vsslabel.html b/docs/manual/OptionalTasks/vsslabel.html deleted file mode 100644 index aab44f200..000000000 --- a/docs/manual/OptionalTasks/vsslabel.html +++ /dev/null @@ -1,83 +0,0 @@ - - - - -Assigns a label to the specified version or current version of a file or -project.
-| Attribute | -Values | -Required | -
|---|---|---|
| login | -username,password | -No | -
| vsspath | -SourceSafe path | -Yes | -
| serverPath | -directory where srssafe.ini resides. |
- No | -
| ssdir | -directory where ss.exe resides. By default the task
- expects it to be in the PATH. |
- No | -
| label | -A label to apply to the hierarchy | -Yes | -
| version | -An existing file or project version to label. By default the current - version is labelled. | -No | -
---<vsslabel vsspath="/source/aProject" - login="me,mypassword" - label="Release1"/> --
Labels the current version of the VSS project $/source/aproject with -the label Release1 using the username me and the password -mypassword. -
----<vsslabel vsspath="/source/aProject/myfile.txt" - version="4" - label="1.03.004"/> --
Labels version 4 of the VSS file $/source/aproject/myfile.txt with the -label 1.03.004. If this version already has a label, the operation (and -the build) will fail. -
- -Copyright © 2000,2001 Apache Software Foundation. All rights -Reserved.
- - - diff --git a/docs/manual/optionaltasklist.html b/docs/manual/optionaltasklist.html index d011fc637..ec7a1db8c 100644 --- a/docs/manual/optionaltasklist.html +++ b/docs/manual/optionaltasklist.html @@ -40,9 +40,7 @@ Telnet