ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ste...@apache.org
Subject cvs commit: jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/vss MSVSS.java MSVSSADD.java MSVSSCHECKIN.java MSVSSCHECKOUT.java MSVSSCP.java MSVSSCREATE.java MSVSSGET.java MSVSSHISTORY.java MSVSSLABEL.java
Date Sun, 23 Jun 2002 19:29:35 GMT
stevel      2002/06/23 12:29:35

  Modified:    src/main/org/apache/tools/ant/taskdefs/optional/vss Tag:
                        ANT_15_BRANCH MSVSS.java MSVSSADD.java
                        MSVSSCHECKIN.java MSVSSCHECKOUT.java MSVSSCP.java
                        MSVSSCREATE.java MSVSSGET.java MSVSSHISTORY.java
                        MSVSSLABEL.java
  Log:
  the VSS tasks documented.
  
  This set of tasks are due for a major refactoring, and a cleanup of all the setters that
assume a set string of "null" means that ant couldnt expand a variable.
  
  Revision  Changes    Path
  No                   revision
  
  
  No                   revision
  
  
  1.19.2.1  +11 -7     jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.java
  
  Index: MSVSS.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.java,v
  retrieving revision 1.19
  retrieving revision 1.19.2.1
  diff -u -r1.19 -r1.19.2.1
  --- MSVSS.java	15 Apr 2002 14:56:34 -0000	1.19
  +++ MSVSS.java	23 Jun 2002 19:29:35 -0000	1.19.2.1
  @@ -86,7 +86,8 @@
       private String m_serverPath = null;
   
       /**
  -     * Set the directory where ss.exe is located
  +     * directory where <code>ss.exe</code> resides; optional.
  +     * By default the task expects it to be in the PATH.
        *
        * @param dir the directory containing ss.exe
        */
  @@ -108,9 +109,11 @@
       }
   
       /**
  -     * Set the login to use when accessing vss.
  +     * The login to use when accessing VSS, formatted as "username,password";
  +     * optional.
        * <p>
  -     * Should be formatted as username,password
  +     * You can omit the password if your database is not password protected.
  +     *  if you have a password and omit it, Ant/VSS will hang.
        *
        * @param login the login string to use
        */
  @@ -130,11 +133,13 @@
       }
   
       /**
  -     * Set the path to the item in vss to operate on.
  +     * SourceSafe path which specifies the project/file(s) you wish to 
  +     * perform the action on; required. You should not specify the leading dollar-sign
- 
  +     * it is prepended by Ant automatically.
        * <p>
        * Ant can't cope with a '$' sign in an attribute so we have to add it here.
        * Also we strip off any 'vss://' prefix which is an XMS special and should probably
be removed!
  -     *
  +     * @todo dont add a $ prefix if it has one
        * @param vssPath
        */
       public final void setVsspath(String vssPath) {
  @@ -153,8 +158,7 @@
       }
   
       /**
  -     * Set the path to the location of the ss.ini
  -     *
  +     * Set the directory where <code>srssafe.ini</code> resides; optional.
        * @param serverPath
        */
       public final void setServerpath(String serverPath) {
  
  
  
  1.4.2.2   +6 -2      jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java
  
  Index: MSVSSADD.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java,v
  retrieving revision 1.4.2.1
  retrieving revision 1.4.2.2
  diff -u -r1.4.2.1 -r1.4.2.2
  --- MSVSSADD.java	22 Jun 2002 23:26:05 -0000	1.4.2.1
  +++ MSVSSADD.java	23 Jun 2002 19:29:35 -0000	1.4.2.2
  @@ -136,7 +136,7 @@
       }
   
       /**
  -     * Set behaviour, used in get command to make files that are 'got' writable
  +     * Leave added files writable? Default: false. 
        */
       public final void setWritable(boolean argWritable) {
           m_Writable = argWritable;
  @@ -153,6 +153,10 @@
           }
       }
   
  +    /**
  +     * What to respond with (sets the -I option). By default, -I- is
  +     * used; values of Y or N will be appended to this.
  +     */      
       public void setAutoresponse(String response){
           if (response.equals("") || response.equals("null")) {
               m_AutoResponse = null;
  @@ -183,7 +187,7 @@
       }
   
       /**
  -     * Sets the comment to apply in SourceSafe.
  +     * Sets the comment to apply; optional.
        * <p>
        * If this is null or empty, it will be replaced with "-" which
        * is what SourceSafe uses for an empty comment.
  
  
  
  1.8.2.1   +8 -3      jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKIN.java
  
  Index: MSVSSCHECKIN.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKIN.java,v
  retrieving revision 1.8
  retrieving revision 1.8.2.1
  diff -u -r1.8 -r1.8.2.1
  --- MSVSSCHECKIN.java	15 Apr 2002 12:11:49 -0000	1.8
  +++ MSVSSCHECKIN.java	23 Jun 2002 19:29:35 -0000	1.8.2.1
  @@ -156,7 +156,8 @@
       }
   
       /**
  -     * Set behaviour recursive or non-recursive
  +     * Flag to tell the task to recurse down the tree;
  +     * optional, default false.
        */
       public void setRecursive(boolean recursive) {
           m_Recursive = recursive;
  @@ -174,7 +175,7 @@
       }
   
       /**
  -     * Set behaviour, used in get command to make files that are 'got' writable
  +     * Leave checked in files writable? Default: false. 
        */
       public final void setWritable(boolean argWritable) {
           m_Writable = argWritable;
  @@ -191,6 +192,10 @@
           }
       }
   
  +    /**
  +     * What to respond with (sets the -I option). By default, -I- is
  +     * used; values of Y or N will be appended to this.
  +     */    
       public void setAutoresponse(String response){
           if (response.equals("") || response.equals("null")) {
               m_AutoResponse = null;
  @@ -221,7 +226,7 @@
       }
   
       /**
  -     * Set the comment to apply in SourceSafe.
  +     * Set the comment to apply; optional.
        * <p>
        * If this is null or empty, it will be replaced with "-" which
        * is what SourceSafe uses for an empty comment.
  
  
  
  1.8.2.1   +17 -20    jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKOUT.java
  
  Index: MSVSSCHECKOUT.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKOUT.java,v
  retrieving revision 1.8
  retrieving revision 1.8.2.1
  diff -u -r1.8 -r1.8.2.1
  --- MSVSSCHECKOUT.java	15 Apr 2002 12:11:49 -0000	1.8
  +++ MSVSSCHECKOUT.java	23 Jun 2002 19:29:35 -0000	1.8.2.1
  @@ -62,7 +62,8 @@
   
   /**
    * Task to perform CheckOut commands to Microsoft Visual Source Safe.
  - *
  + * <p>If you specify two or more attributes from version, date and 
  + * label only one will be used in the order version, date, label.</p>
    * @author Martin Poeschl
    *
    * @ant.task name="vsscheckout" category="scm"
  @@ -153,7 +154,8 @@
       }
   
       /**
  -     * Set behaviour recursive or non-recursive
  +     * Flag to tell the task to recurse down the tree;
  +     * optional, default false.
        */
       public void setRecursive(boolean recursive) {
           m_Recursive = recursive;
  @@ -171,12 +173,9 @@
       }
   
       /**
  -     * Set the stored version string.
  -     * <p>
  -     * Note we assume that if the supplied string has the value "null" that something
  -     * went wrong and that the string value got populated from a null object. This
  -     * happens if a ant variable is used e.g. version="${ver_server}" when ver_server
  -     * has not been defined to ant!
  +     * Set the version to get;
  +     * optional, only one of <tt>version</tt>, <tt>label</tt>,
or <tt>date</tt>
  +     * allowed.
        */
       public void setVersion(String version) {
           if (version.equals("") || version.equals("null")) {
  @@ -187,12 +186,9 @@
       }
   
       /**
  -     * Set the stored date string.
  -     * <p>
  -     * Note we assume that if the supplied string has the value "null" that something
  -     * went wrong and that the string value got populated from a null object. This
  -     * happens if a ant variable is used e.g. date="${date}" when date
  -     * has not been defined to ant!
  +     * Set the date to get;
  +     * optional, only one of <tt>version</tt>, <tt>label</tt>,
or <tt>date</tt>
  +     * allowed.
        */
       public void setDate(String date) {
           if (date.equals("") || date.equals("null")) {
  @@ -203,12 +199,9 @@
       }
   
       /**
  -     * Set the labeled version to operate on in SourceSafe.
  -     * <p>
  -     * Note we assume that if the supplied string has the value "null" that something
  -     * went wrong and that the string value got populated from a null object. This
  -     * happens if a ant variable is used e.g. label="${label_server}" when label_server
  -     * has not been defined to ant!
  +     * Set the label to get;
  +     * optional, only one of <tt>version</tt>, <tt>label</tt>,
or <tt>date</tt>
  +     * allowed.
        */
       public void setLabel(String label) {
           if (label.equals("") || label.equals("null")) {
  @@ -233,6 +226,10 @@
           }
       }
   
  +    /**
  +     * What to respond with (sets the -I option). By default, -I- is
  +     * used; values of Y or N will be appended to this.
  +     */    
       public void setAutoresponse(String response){
           if (response.equals("") || response.equals("null")) {
               m_AutoResponse = null;
  
  
  
  1.3.2.1   +5 -0      jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCP.java
  
  Index: MSVSSCP.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCP.java,v
  retrieving revision 1.3
  retrieving revision 1.3.2.1
  diff -u -r1.3 -r1.3.2.1
  --- MSVSSCP.java	15 Apr 2002 12:11:49 -0000	1.3
  +++ MSVSSCP.java	23 Jun 2002 19:29:35 -0000	1.3.2.1
  @@ -59,6 +59,7 @@
   
   /**
    * Task to perform CP (Change Project) commands to Microsoft Visual Source Safe.
  + * <p>This task is typically used before a VssAdd in order to set the target project</p>
    * Based on the VSS Checkin code by Martin Poeschl
    *
    * @author Nigel Magnay
  @@ -107,6 +108,10 @@
           }
       }
   
  +    /**
  +     * What to respond with (sets the -I option). By default, -I- is
  +     * used; values of Y or N will be appended to this.
  +     */     
       public void setAutoresponse(String response) {
           if (response.equals("") || response.equals("null")) {
               m_AutoResponse = null;
  
  
  
  1.3.2.2   +6 -4      jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.java
  
  Index: MSVSSCREATE.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.java,v
  retrieving revision 1.3.2.1
  retrieving revision 1.3.2.2
  diff -u -r1.3.2.1 -r1.3.2.2
  --- MSVSSCREATE.java	22 Jun 2002 23:26:05 -0000	1.3.2.1
  +++ MSVSSCREATE.java	23 Jun 2002 19:29:35 -0000	1.3.2.2
  @@ -58,7 +58,7 @@
   import org.apache.tools.ant.types.Commandline;
   
   /**
  - * Task to perform CREATE commands to Microsoft Visual Source Safe.
  + * Creates a new project in VSS.
    * <p>
    * The following attributes are interpreted:
    * <table border="1">
  @@ -195,7 +195,7 @@
       }
   
       /**
  -     * Sets/clears quiet mode
  +     * Sets/clears quiet mode; optional, default false.
        * @param quiet whether or not command should be run in "quiet mode".
        */
       public final void setQuiet (boolean quiet) {
  @@ -213,7 +213,8 @@
       }
   
       /**
  -     * Sets whether task should fail if there is an error creating the project.
  +     * Sets whether task should fail if there is an error creating the project;
  +     * optional, default true.
        * @param failOnError true if task should fail if there is an error creating 
        * the project.
        */
  @@ -222,7 +223,8 @@
       }
   
       /**
  -     * Sets the AutoResponse.
  +     * What to respond with (sets the -I option). By default, -I- is
  +     * used; values of Y or N will be appended to this.
        * @param response the response.
        */
       public void setAutoresponse(String response) {
  
  
  
  1.17.2.1  +24 -8     jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSGET.java
  
  Index: MSVSSGET.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSGET.java,v
  retrieving revision 1.17
  retrieving revision 1.17.2.1
  diff -u -r1.17 -r1.17.2.1
  --- MSVSSGET.java	15 Apr 2002 12:11:49 -0000	1.17
  +++ MSVSSGET.java	23 Jun 2002 19:29:35 -0000	1.17.2.1
  @@ -63,7 +63,7 @@
   /**
    * Task to perform GET commands to Microsoft Visual Source Safe.
    * <p>
  - * The following attributes are interpretted:
  + * The following attributes are interpreted:
    * <table border="1">
    *   <tr>
    *     <th>Attribute</th>
  @@ -189,7 +189,7 @@
       }
   
       /**
  -     * Set the local path.
  +     * Override the working directory and get to the specified path; optional.
        */
       public void setLocalpath(Path localPath) {
           m_LocalPath = localPath.toString();
  @@ -221,7 +221,8 @@
       }
   
       /**
  -     * Set behaviour recursive or non-recursive
  +     * Flag to tell the task to recurse down the tree;
  +     * optional, default false.
        */
       public void setRecursive(boolean recursive) {
           m_Recursive = recursive;
  @@ -239,7 +240,7 @@
       }
   
       /**
  -     * Sets/clears quiet mode
  +     * Flag to suppress output when true ; false by default.
        */
       public final void setQuiet (boolean quiet) {
           this.m_Quiet = quiet;
  @@ -252,7 +253,7 @@
       }
       
       /**
  -     * Set behaviour, used in get command to make files that are 'got' writable
  +     * make fetched files  writable; optional, default false.
        */
       public final void setWritable(boolean argWritable) {
           m_Writable = argWritable;
  @@ -270,12 +271,17 @@
       }
   
       /**
  -     * Set the stored version string.
  +     * Set a version number to get; 
  +     * optional, only one of <tt>version</tt>, <tt>label</tt>,
or <tt>date</tt>
  +     * allowed.
        * <p>
  +     * ORIGINAL COMMENT THAT DOES NOT SEEM AT ALL VALID:
        * Note we assume that if the supplied string has the value "null" that something
        * went wrong and that the string value got populated from a null object. This
        * happens if a ant variable is used e.g. version="${ver_server}" when ver_server
        * has not been defined to ant!
  +     * NO, in this case the version string is "${ver_server}".
  +     * @todo fix this
        */
       public void setVersion(String version) {
           if (version.equals("") || version.equals("null")) {
  @@ -286,12 +292,16 @@
       }
   
       /**
  -     * Set the stored date string.
  +     * Set the date to get;
  +     * optional, only one of <tt>version</tt>, <tt>label</tt>,
or <tt>date</tt>
  +     * allowed.
        * <p>
  +     * ORIGINAL COMMENT THAT DOES NOT SEEM AT ALL VALID:
        * Note we assume that if the supplied string has the value "null" that something
        * went wrong and that the string value got populated from a null object. This
        * happens if a ant variable is used e.g. date="${date}" when date
        * has not been defined to ant!
  +     * @todo fix this
        */
       public void setDate(String date) {
           if (date.equals("") || date.equals("null")) {
  @@ -302,7 +312,9 @@
       }
   
       /**
  -     * Set the labeled version to operate on in SourceSafe.
  +     * Set the label to get;
  +     * optional, only one of <tt>version</tt>, <tt>label</tt>,
or <tt>date</tt>
  +     * allowed.
        * <p>
        * Note we assume that if the supplied string has the value "null" that something
        * went wrong and that the string value got populated from a null object. This
  @@ -332,6 +344,10 @@
           }
       }
   
  +    /**
  +     * What to respond with (sets the -I option). By default, -I- is
  +     * used; values of Y or N will be appended to this.
  +     */
       public void setAutoresponse(String response){
           if (response.equals("") || response.equals("null")) {
               m_AutoResponse = null;
  
  
  
  1.9.2.1   +18 -11    jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSHISTORY.java
  
  Index: MSVSSHISTORY.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSHISTORY.java,v
  retrieving revision 1.9
  retrieving revision 1.9.2.1
  diff -u -r1.9 -r1.9.2.1
  --- MSVSSHISTORY.java	15 Apr 2002 14:56:34 -0000	1.9
  +++ MSVSSHISTORY.java	23 Jun 2002 19:29:35 -0000	1.9.2.1
  @@ -156,7 +156,7 @@
       }
   
       /**
  -     * Set the Start Date for the Comparison of two versions in SourceSafe History
  +     * Set the Start Date for the Comparison of two versions; optional.
        */
       public void setFromDate(String fromDate) {
           if (fromDate.equals("") || fromDate == null) {
  @@ -167,7 +167,7 @@
       }
   
       /**
  -     * Set the Start Label 
  +     * Set the Start Label; optional
        */
       public void setFromLabel(String fromLabel) {
           if (fromLabel.equals("") || fromLabel == null) {
  @@ -178,7 +178,7 @@
       }
   
       /**
  -     * Set the End Label 
  +     * Set the End Label ; optional
        */
       public void setToLabel(String toLabel) {
           if (toLabel.equals("") || toLabel == null) {
  @@ -189,7 +189,7 @@
       }
   
       /**
  -     * Set the End Date for the Comparison of two versions in SourceSafe History
  +     * Set the End Date for the Comparison of two versions; optional.
        */
       public void setToDate(String toDate) {
           if (toDate.equals("") || toDate == null) {
  @@ -200,16 +200,17 @@
       }
   
       /**
  -     * Set the number of days to go back for Comparison.
  +     * Set the number of days for comparison; 
  +     * optional.
        * <p>
  -     * The default value is 2 days. 
  +     * The default value is 2 days. (maybe)
        */
       public void setNumdays(int numd) {
           m_NumDays = numd;
       }
       
       /**
  -     * Set the output file name for SourceSafe output.
  +     * Set the output file name for the history; optional.
        */
       public void setOutput(File outfile) {
           if (outfile == null) {
  @@ -220,7 +221,11 @@
       }
   
       /**
  -     * Set the Start Date for the Comparison of two versions in SourceSafe History.
  +     * Format of dates in fromDate and toDate; optional.
  +     * Used when calculating dates with 
  +     * the numdays attribute. 
  +     * This string uses the formatting rules of SimpleDateFormat. 
  +     *  Defaults to DateFormat.SHORT.
        */
       public void setDateFormat(String dateFormat) {
           if (!(dateFormat.equals("") || dateFormat == null)) {
  @@ -323,14 +328,16 @@
       }
   
       /**
  -     * Set behaviour recursive or non-recursive
  +     * Flag to tell the task to recurse down the tree;
  +     * optional, default false.
        */
  +
       public void setRecursive(boolean recursive) {
           m_Recursive = recursive;
       }
   
       /**
  -     * Set the Username of the user whose changes we would like to see.
  +     * Name the user whose changes we would like to see; optional
        */
       public void setUser(String user) {
           m_User = user;
  @@ -348,7 +355,7 @@
       }
   
       /**
  -     * Specify the detail of output.
  +     * Specify the output style; optional.
        *
        * @param option valid values:
        * <ul>
  
  
  
  1.11.2.1  +13 -3     jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSLABEL.java
  
  Index: MSVSSLABEL.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSLABEL.java,v
  retrieving revision 1.11
  retrieving revision 1.11.2.1
  diff -u -r1.11 -r1.11.2.1
  --- MSVSSLABEL.java	15 Apr 2002 14:56:34 -0000	1.11
  +++ MSVSSLABEL.java	23 Jun 2002 19:29:35 -0000	1.11.2.1
  @@ -176,12 +176,13 @@
       }
   
       /**
  -     * Set the label to apply in SourceSafe.
  +     * Set the label to apply; required.
        * <p>
        * Note we assume that if the supplied string has the value "null" that something
        * went wrong and that the string value got populated from a null object. This
        * happens if a ant variable is used e.g. label="${label_server}" when label_server
        * has not been defined to ant!
  +     * @todo correct. 
        */
       public void setLabel(String label) {
           if (label.equals("") || label.equals("null")) {
  @@ -212,12 +213,14 @@
       }
   
       /**
  -     * Set the stored version string.
  +     * Name an existing file or project version to label; optional.
  +     * By default the current version is labelled.
        * <p>
        * Note we assume that if the supplied string has the value "null" that something
        * went wrong and that the string value got populated from a null object. This
        * happens if a ant variable is used e.g. version="${ver_server}" when ver_server
        * has not been defined to ant!
  +     * @todo fix
        */
       public void setVersion(String version) {
           if (version.equals("") || version.equals("null")) {
  @@ -236,10 +239,12 @@
       }
   
       /**
  -     * Set the comment to apply in SourceSafe.
  +     * The comment to use for this label; optional.
  +     * Empty or '-' for no comment.
        * <p>
        * If this is null or empty, it will be replaced with "-" which
        * is what SourceSafe uses for an empty comment.
  +      *@todo correct
        */
       public void setComment(String comment) {
           if (comment.equals("") || comment.equals("null")) {
  @@ -256,6 +261,11 @@
       public String getComment() {
           return m_Comment;
       }
  +    
  +    /**
  +     * What to respond with (sets the -I option). By default, -I- is
  +     * used; values of Y or N will be appended to this.
  +     */
       
       public void setAutoresponse(String response){
           if (response.equals("") || response.equals("null")) {
  
  
  

--
To unsubscribe, e-mail:   <mailto:ant-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:ant-dev-help@jakarta.apache.org>


Mime
View raw message