stevel 2002/06/23 00:27:10
Modified: src/main/org/apache/tools/ant/taskdefs/optional/sos Tag:
ANT_15_BRANCH SOS.java SOSGet.java SOSLabel.java
Log:
updates to SOS.
Revision Changes Path
No revision
No revision
1.5.2.1 +25 -18
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOS.java
Index: SOS.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOS.java,v
retrieving revision 1.5
retrieving revision 1.5.2.1
diff -u -r1.5 -r1.5.2.1
--- SOS.java 12 Apr 2002 13:26:53 -0000 1.5
+++ SOS.java 23 Jun 2002 07:27:10 -0000 1.5.2.1
@@ -119,7 +119,8 @@
/**
- * Disable the cache
+ * flag to disable the cache when set;
+ * optional needed if SOSHOME is set as an environment variable.
*
* @param nocache The new noCache value
*/
@@ -129,9 +130,9 @@
/**
- * Disable compression
+ * Flag that disables compression when set; optional, default
*
- * @param nocompress The new noCompress value
+ * @param nocompress true to disable compression
*/
public void setNoCompress(boolean nocompress) {
noCompress = nocompress;
@@ -139,7 +140,8 @@
/**
- * Set the directory where soscmd(.exe) is located
+ * Set the directory where soscmd(.exe) is located;
+ * optional, soscmd must be on the path if omitted.
*
* @param dir The new sosCmd value
*/
@@ -149,7 +151,7 @@
/**
- * Set the username to use to access SOS.
+ * Set the SourceSafe username; required.
*
* @param username The new username value
*/
@@ -159,7 +161,7 @@
/**
- * Set the password to use to access SOS.
+ * Set the SourceSafe password; optional.
*
* @param password The new password value
*/
@@ -169,9 +171,7 @@
/**
- * Set the path to the item in SOS to operate on.
- * <p>
- * To avoid the "$$" in th build file we add it here
+ * Set the SourceSafe project path without the "$" prefix; required
*
* @param projectpath The new projectPath value
*/
@@ -181,7 +181,8 @@
/**
- * Set the path to the location of the ss.ini.
+ * Set the path to the location of the ss.ini file;
+ * required.
*
* @param vssServerPath The new vssServerPath value
*/
@@ -191,7 +192,7 @@
/**
- * Set the path of soshome
+ * The path to the SourceOffSite home directory
*
* @param sosHome The new sosHome value
*/
@@ -201,7 +202,8 @@
/**
- * Set the address & port of SourceOffSite Server
+ * Set the address and port of SourceOffSite Server,
+ * eg. 192.168.0.1:8888 ; required.
*
* @param sosServerPath The new sosServerPath value
*/
@@ -211,7 +213,7 @@
/**
- * Set the local path.
+ * Override the working directory and get to the specified path;
optional.
*
* @param path The new localPath value
*/
@@ -221,7 +223,9 @@
/**
- * Set the filename to get from SOS
+ * Set the Filename to act upon; optional.
+ * If no file is specified then the tasks
+ * act upon the project
*
* @param filename The new file value
*/
@@ -231,7 +235,7 @@
/**
- * Set behaviour verbose or quiet
+ * Enable verbose output; optional, default false
*
* @param verbose The new verbose value
*/
@@ -241,7 +245,8 @@
/**
- * Set behaviour recursive or non-recursive
+ * Flag to recursively apply the action (not valid
+ * on all SOS tasks ); optional, default false
*
* @param recursive The new recursive value
*/
@@ -251,7 +256,8 @@
/**
- * Set the stored version string
+ * Set the a version number to get -
+ * only works with the SOSGet on a file; optional.
*
* @param version The new version value
*/
@@ -271,7 +277,8 @@
/**
- * Set the comment to get
+ * Set the comment to apply to all files being labelled;
+ * optional, only valid in SOSLabel
*
* @param comment The new comment value
*/
1.4.2.1 +2 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSGet.java
Index: SOSGet.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSGet.java,v
retrieving revision 1.4
retrieving revision 1.4.2.1
diff -u -r1.4 -r1.4.2.1
--- SOSGet.java 12 Apr 2002 13:26:53 -0000 1.4
+++ SOSGet.java 23 Jun 2002 07:27:10 -0000 1.4.2.1
@@ -57,7 +57,8 @@
import org.apache.tools.ant.types.Commandline;
/**
- * Task to retreive file(s) from Visual Source Safe via a SourceOffSite
server.
+ * Task to retrieve a read-only copy of the specified project or file.
+ * from Visual Source Safe via a SourceOffSite server.
* <p>
* The following attributes are interpretted:
* <table border="1">
1.4.2.1 +1 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSLabel.java
Index: SOSLabel.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSLabel.java,v
retrieving revision 1.4
retrieving revision 1.4.2.1
diff -u -r1.4 -r1.4.2.1
--- SOSLabel.java 12 Apr 2002 13:26:53 -0000 1.4
+++ SOSLabel.java 23 Jun 2002 07:27:10 -0000 1.4.2.1
@@ -59,7 +59,7 @@
/**
* Task to label a Visual Source Safe via a SourceOffSite server.
* <p>
- * The following attributes are interpretted:
+ * The following attributes are interpreted:
* <table border="1">
* <tr>
* <th>Attribute</th>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
