ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hol...@apache.org
Subject cvs commit: jakarta-ant/docs/manual/CoreTasks buildnumber.html changelog.html
Date Sun, 31 Mar 2002 01:17:57 GMT
holtdl      02/03/30 17:17:57

  Modified:    docs/manual coretasklist.html tasksoverview.html
               docs/manual/CoreTasks buildnumber.html changelog.html
  Log:
  Do a bit of clean-up on <buildnumber>/<changelog> docs;
  add them to the tasks tables; add <buildnumber> to the
  core tasks list.
  
  Revision  Changes    Path
  1.36      +2 -1      jakarta-ant/docs/manual/coretasklist.html
  
  Index: coretasklist.html
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/docs/manual/coretasklist.html,v
  retrieving revision 1.35
  retrieving revision 1.36
  diff -u -r1.35 -r1.36
  --- coretasklist.html	28 Mar 2002 22:56:48 -0000	1.35
  +++ coretasklist.html	31 Mar 2002 01:17:57 -0000	1.36
  @@ -19,9 +19,10 @@
   <a href="CoreTasks/apply.html">Apply/<i>ExecOn</i></a><br>
   <a href="CoreTasks/available.html">Available</a><br>
   <a href="CoreTasks/basename.html">Basename</a><br>
  +<a href="CoreTasks/buildnumber.html">BuildNumber</a><br>
   <a href="CoreTasks/unpack.html">BUnzip2</a><br>
   <a href="CoreTasks/pack.html">BZip2</a><br>
  -<a href="CoreTasks/changelog.html">Changelog</a><br>
  +<a href="CoreTasks/changelog.html">ChangeLog</a><br>
   <a href="CoreTasks/checksum.html">Checksum</a><br>
   <a href="CoreTasks/chmod.html">Chmod</a><br>
   <a href="CoreTasks/condition.html">Condition</a><br>
  
  
  
  1.6       +12 -0     jakarta-ant/docs/manual/tasksoverview.html
  
  Index: tasksoverview.html
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/docs/manual/tasksoverview.html,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- tasksoverview.html	22 Mar 2002 18:35:49 -0000	1.5
  +++ tasksoverview.html	31 Mar 2002 01:17:57 -0000	1.6
  @@ -820,6 +820,11 @@
     </tr>
   
     <tr valign="top">
  +    <td nowrap><a href="CoreTasks/buildnumber.html">BuildNumber</a></td>
  +    <td><p>Task that can be used to track build numbers.
  +  </tr>
  +
  +  <tr valign="top">
       <td nowrap><a href="CoreTasks/condition.html">Condition</a></td>
       <td><p>Sets a property if a certain condition holds true - this is a
        generalization of <a href="CoreTasks/available.html">Available</a> and
  @@ -921,6 +926,13 @@
     <tr valign="top">
       <th nowrap>Task Name</th>
       <th>Description</th>
  +  </tr>
  +
  +  <tr valign="top">
  +    <td nowrap><a href="CoreTasks/changelog.html">ChangeLog</a></td>
  +    <td><p>Generates an XML report of the changes recorded in a
  +     <a href="http://www.cvshome.org/" target="_top">CVS</a>
  +     repository.</p></td>
     </tr>
   
     <tr valign="top">
  
  
  
  1.2       +20 -12    jakarta-ant/docs/manual/CoreTasks/buildnumber.html
  
  Index: buildnumber.html
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/docs/manual/CoreTasks/buildnumber.html,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- buildnumber.html	29 Mar 2002 01:30:41 -0000	1.1
  +++ buildnumber.html	31 Mar 2002 01:17:57 -0000	1.2
  @@ -2,18 +2,24 @@
   
   <head>
   <meta http-equiv="Content-Language" content="en-us">
  -<title>Buildnumber Task</title>
  +<title>BuildNumber Task</title>
   </head>
   
   <body>
   
  -<h2><a name="buildnumber">Buildnumber</a></h2>
  +<h2><a name="buildnumber">BuildNumber</a></h2>
   <h3>Description</h3>
   <p>This is a basic task that can be used to track build numbers.</p>
  -<p>It will first attempt to read a build number from a file, then
  -set the property "build.number" to the value that was read in
  -(or 0 if no such value). Then it will increment the build number
  -by one and write it back out into the file.</p>
  +<p>It will first attempt to read a build number from a file (by default,
  +<code>build.number</code> in the current directory), then
  +set the property <code>build.number</code> to the value that was read in
  +(or to <code>0</code>, if no such value). It will then increment the
  +number by one and write it back out to the file.
  +(See the
  +<a href="../OptionalTasks/propertyfile.html">PropertyFile</a> task
  +if you need finer control over things such as the property name or
  +the number format.)
  +</p>
   
   <h3>Parameters</h3>
   <table border="1" cellpadding="2" cellspacing="0">
  @@ -24,22 +30,24 @@
     </tr>
     <tr>
       <td valign="top">file</td>
  -    <td valign="top">the file to read and write build number from.</td>
  -    <td align="center" valign="top">No, defaults to &quot;build.number&quot;</td>
  +    <td valign="top">The file to read and write the build number from/to.</td>
  +    <td align="center" valign="top">No; defaults to &quot;build.number&quot;</td>
     </tr>
   </table>
   
   <h3>Examples</h3>
   <pre>  &lt;buildnumber/&gt;</pre>
   
  -<p>Read, increment and write a build number to the default file &quot;build.number&quot;.</p>
  +<p>Read, increment, and write a build number to the default file,
  +<code>build.number</code>.</p>
   
   <pre>  &lt;buildnumber file=&quot;mybuild.number&quot;/&gt;</pre>
   
  -<p>Read, increment and write a build number to the file &quot;mybuild.number&quot;.</p>
  +<p>Read, increment, and write a build number to the file
  +<code>mybuild.number</code>.</p>
   
  -<hr><p align="center">Copyright &copy; 2002 Apache Software Foundation.
All rights
  -Reserved.</p>
  +<hr><p align="center">Copyright &copy; 2002 Apache Software Foundation.
  +All rights Reserved.</p>
   
   </body>
   </html>
  
  
  
  1.8       +62 -45    jakarta-ant/docs/manual/CoreTasks/changelog.html
  
  Index: changelog.html
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/docs/manual/CoreTasks/changelog.html,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- changelog.html	30 Mar 2002 23:51:33 -0000	1.7
  +++ changelog.html	31 Mar 2002 01:17:57 -0000	1.8
  @@ -2,14 +2,14 @@
   
   <head>
   <meta http-equiv="Content-Language" content="en-us">
  -<title>Changelog Task</title>
  +<title>ChangeLog Task</title>
   </head>
   
   <body>
   
  -<h2><a name="changelog">Changelog</a></h2>
  +<h2><a name="changelog">ChangeLog</a></h2>
   <h3>Description</h3>
  -<p>Generates an XML report of the changes recorded in a
  +<p>Generates an XML-formatted report file of the change logs recorded in a
   <a href="http://www.cvshome.org/" target="_top">CVS</a> repository. </p>
   <h3>Parameters</h3>
   <table border="1" cellpadding="2" cellspacing="0">
  @@ -20,42 +20,51 @@
     </tr>
     <tr>
       <td valign="top">dir</td>
  -    <td valign="top">the directory from which to run &quot;cvs log&quot;.</td>
  -    <td align="center" valign="top">No, will default to projects basedir</td>
  +    <td valign="top">The directory from which to run the CVS <em>log</em>
  +     command.</td>
  +    <td align="center" valign="top">No; defaults to ${basedir}.</td>
     </tr>
     <tr>
       <td valign="top">destfile</td>
  -    <td valign="top">the file in which to write the changelog.</td>
  +    <td valign="top">The file in which to write the change log report.</td>
       <td align="center" valign="top">Yes</td>
     </tr>
     <tr>
       <td valign="top">usersfile</td>
  -    <td valign="top">property file that contains mapping between userids and display
names.</td>
  +    <td valign="top">Property file that contains name-value pairs mapping
  +     user IDs and names that should be used in the report in place of
  +     the user ID.</td>
       <td align="center" valign="top">No</td>
     </tr>
     <tr>
       <td valign="top">daysinpast</td>
  -    <td valign="top">sets the start the number of days into the past specified.</td>
  +    <td valign="top">Sets the number of days into the past for which the
  +     change log information should be retrieved.</td>
       <td align="center" valign="top">No</td>
     </tr>
     <tr>
       <td valign="top">start</td>
  -    <td valign="top">the earliest date of changes that are to be included in report.</td>
  +    <td valign="top">The earliest date from which change logs are to be
  +     included in the report.</td>
       <td align="center" valign="top">No</td>
     </tr>
     <tr>
       <td valign="top">end</td>
  -    <td valign="top">the latest date of changes that are to be included in report.</td>
  +    <td valign="top">The latest date to which change logs are to be
  +     included in the report.</td>
       <td align="center" valign="top">No</td>
     </tr>
   </table>
   
   <h3>Parameters specified as nested elements</h3>
   <h4><a name="user">user</a></h4>
  -<p>The changelog task all allows a user element. It maps between a usernid
  -as it appears on the cvs server and a display name. Any time the userid
  -has made a change in the repository, the author tag in report will use
  -the supplied displayname rather than the userid..</p>
  +<p>The nested <code>&lt;user&gt;</code> element allows you to
specify a
  +mapping between a user ID as it appears on the CVS server and a name to
  +include in the formatted report.
  +Anytime the specified user ID has made a change in the repository, the
  +<code>&lt;author&gt;</code> tag in the report file will include
  +the name specified in <code>displayname</code> rather than the user ID.
  +</p>
   
   <table border="1" cellpadding="2" cellspacing="0">
     <tr>
  @@ -65,75 +74,83 @@
     </tr>
     <tr>
       <td valign="top">displayname</td>
  -    <td valign="top">The name to be displayed in CVS changelog.</td>
  +    <td valign="top">The name to be used in the CVS change log report.</td>
       <td valign="top" align="center">Yes</td>
     </tr>
     <tr>
       <td valign="top">userid</td>
  -    <td valign="top">The userid of person as they exist on the CVS server.</td>
  +    <td valign="top">The userid of the person as it exists on the CVS server.
  +    </td>
       <td valign="top" align="center">Yes</td>
     </tr>
   </table>
   
   
   <h3>Examples</h3>
  -<pre>  &lt;changelog basedir=&quot;dve/network&quot;
  +<pre>  &lt;changelog dir=&quot;dve/network&quot;
                destfile=&quot;changelog.xml&quot;
     /&gt;</pre>
   
  -<p>Generates a changelog for the dve/network directory including all changes that
  -ever occured on repository. It writes these changes into the file &quot;changelog.xml&quot;.</p>
  +<p>Generates a change log report for all the changes that have been made
  +under the <code>dve/network</code> directory.
  +It writes these changes into the file <code>changelog.xml</code>.</p>
   
  -<pre>  &lt;changelog basedir=&quot;dve/network&quot;
  +<pre>  &lt;changelog dir=&quot;dve/network&quot;
                destfile=&quot;changelog.xml&quot;
                daysinpast=&quot;10&quot;
     /&gt;</pre>
   
  -<p>Generates a changelog for the dve/network directory for the last 10 days. It writes
  -these changes into the file &quot;changelog.xml&quot;.</p>
  +<p>Generates a change log report for any changes that were made
  +under the <code>dve/network</code> directory in the past 10 days.
  +It writes these changes into the file <code>changelog.xml</code>.</p>
   
  -<pre>  &lt;changelog basedir=&quot;dve/network&quot;
  +<pre>  &lt;changelog dir=&quot;dve/network&quot;
                destfile=&quot;changelog.xml&quot;
                start=&quot;20 Feb 2002&quot;
                end=&quot;20 Mar 2002&quot;
     /&gt;</pre>
   
  -<p>Generates a changelog for the dve/network directory for all the changes that occured
  -between the dates 20th of Feb 2002 and 20th of Mar 2002. It writes these changes into the
file &quot;changelog.xml&quot;.</p>
  +<p>Generates a change log report for any changes that were made
  +between February 20, 2002 and March 20, 2002
  +under the <code>dve/network</code> directory.
  +It writes these changes into the file <code>changelog.xml</code>.</p>
   
  -<pre>  &lt;changelog basedir=&quot;dve/network&quot;
  +<pre>  &lt;changelog dir=&quot;dve/network&quot;
                destfile=&quot;changelog.xml&quot;
                start=&quot;20 Feb 2002&quot;
     /&gt;</pre>
   
  -<p>Generates a changelog for the dve/network directory for all the changes that occured
  -after the 20th of Feb 2002. It writes these changes into the file &quot;changelog.xml&quot;.</p>
  +<p>Generates a change log report for any changes that were made
  +after February 20, 2002 under the <code>dve/network</code> directory.
  +It writes these changes into the file <code>changelog.xml</code>.</p>
   
  -<pre>  &lt;changelog basedir=&quot;dve/network&quot;
  -             destfile=&quot;changelog.xml&quot;
  +<pre>  &lt;changelog dir=&quot;dve/network&quot;
  +             destfile=&quot;changelog.xml&quot;/&gt;
          &lt;user displayname=&quot;Peter Donald&quot; userid=&quot;donaldp&quot;/&gt;
  -  /&gt;</pre>
  +  &lt;/changelog&gt;</pre>
   
  -<p>Generates a changelog for the dve/network directory for all the changes that
  -ever occured. It will also specify the author name as &quot;Peter Donald&quot;
  -any time it encounters the username &quot;donaldp&quot; in the changes.</p>
  +<p>Generates a change log report for all the changes that were made
  +under the <code>dve/network</code> directory, substituting the name
  +&quot;Peter Donald&quot; in the <code>&lt;author&gt;</code>
tags
  +anytime it encounters a change made by the user ID &quot;donaldp&quot;.
  +It writes these changes into the file <code>changelog.xml</code>.</p>
   
   <h4>Sample Output</h4>
   <pre>
   &lt;changelog&gt;
  -	&lt;entry&gt;
  -		&lt;date&gt;2002-03-06&lt;/date&gt;
  -		&lt;time&gt;12:00&lt;/time&gt;
  -		&lt;author&gt;donaldp&lt;/author&gt;
  -		&lt;file&gt;
  -			&lt;name&gt;org/apache/myrmidon/build/AntlibDescriptorTask.java&lt;/name&gt;
  -			&lt;revision&gt;1.3&lt;/revision&gt;
  -			&lt;prevrevision&gt;1.2&lt;/prevrevision&gt;
  -		&lt;/file&gt;
  -		&lt;msg&gt;&lt;![CDATA[Use URLs directly rather than go via a FIle.
  +  &lt;entry&gt;
  +    &lt;date&gt;2002-03-06&lt;/date&gt;
  +    &lt;time&gt;12:00&lt;/time&gt;
  +    &lt;author&gt;Peter Donald&lt;/author&gt;
  +    &lt;file&gt;
  +      &lt;name&gt;org/apache/myrmidon/build/AntlibDescriptorTask.java&lt;/name&gt;
  +      &lt;revision&gt;1.3&lt;/revision&gt;
  +      &lt;prevrevision&gt;1.2&lt;/prevrevision&gt;
  +    &lt;/file&gt;
  +    &lt;msg&gt;&lt;![CDATA[Use URLs directly rather than go via a FIle.
   
   This allows temp[lates to be stored inside jar]]&gt;&lt;/msg&gt;
  -	&lt;/entry&gt;
  +  &lt;/entry&gt;
   &lt;/changelog&gt;
   </pre>
   
  
  
  

--
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