From a459897fabb3cff23438fcb2e37031da932fd110 Mon Sep 17 00:00:00 2001 From: Diane Holt Date: Sun, 31 Mar 2002 01:17:57 +0000 Subject: [PATCH] Do a bit of clean-up on / docs; add them to the tasks tables; add to the core tasks list. PR: Obtained from: Submitted by: Reviewed by: git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@272119 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/CoreTasks/buildnumber.html | 32 +++++--- docs/manual/CoreTasks/changelog.html | 107 ++++++++++++++----------- docs/manual/coretasklist.html | 3 +- docs/manual/tasksoverview.html | 12 +++ 4 files changed, 96 insertions(+), 58 deletions(-) diff --git a/docs/manual/CoreTasks/buildnumber.html b/docs/manual/CoreTasks/buildnumber.html index 807d1998d..3dc3b38da 100644 --- a/docs/manual/CoreTasks/buildnumber.html +++ b/docs/manual/CoreTasks/buildnumber.html @@ -2,18 +2,24 @@ -Buildnumber Task +BuildNumber Task -

Buildnumber

+

BuildNumber

Description

This is a basic task that can be used to track build numbers.

-

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.

+

It will first attempt to read a build number from a file (by default, +build.number in the current directory), then +set the property build.number to the value that was read in +(or to 0, if no such value). It will then increment the +number by one and write it back out to the file. +(See the +PropertyFile task +if you need finer control over things such as the property name or +the number format.) +

Parameters

@@ -24,22 +30,24 @@ by one and write it back out into the file.

- - + +
filethe file to read and write build number from.No, defaults to "build.number"The file to read and write the build number from/to.No; defaults to "build.number"

Examples

  <buildnumber/>
-

Read, increment and write a build number to the default file "build.number".

+

Read, increment, and write a build number to the default file, +build.number.

  <buildnumber file="mybuild.number"/>
-

Read, increment and write a build number to the file "mybuild.number".

+

Read, increment, and write a build number to the file +mybuild.number.

-

Copyright © 2002 Apache Software Foundation. All rights -Reserved.

+

Copyright © 2002 Apache Software Foundation. +All rights Reserved.

diff --git a/docs/manual/CoreTasks/changelog.html b/docs/manual/CoreTasks/changelog.html index fb767dd9d..ee1f83e7a 100644 --- a/docs/manual/CoreTasks/changelog.html +++ b/docs/manual/CoreTasks/changelog.html @@ -2,14 +2,14 @@ -Changelog Task +ChangeLog Task -

Changelog

+

ChangeLog

Description

-

Generates an XML report of the changes recorded in a +

Generates an XML-formatted report file of the change logs recorded in a CVS repository.

Parameters

@@ -20,42 +20,51 @@ - - + + - + - + - + - + - +
dirthe directory from which to run "cvs log".No, will default to projects basedirThe directory from which to run the CVS log + command.No; defaults to ${basedir}.
destfilethe file in which to write the changelog.The file in which to write the change log report. Yes
usersfileproperty file that contains mapping between userids and display names.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. No
daysinpastsets the start the number of days into the past specified.Sets the number of days into the past for which the + change log information should be retrieved. No
startthe earliest date of changes that are to be included in report.The earliest date from which change logs are to be + included in the report. No
endthe latest date of changes that are to be included in report.The latest date to which change logs are to be + included in the report. No

Parameters specified as nested elements

user

-

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

+

The nested <user> 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 +<author> tag in the report file will include +the name specified in displayname rather than the user ID. +

@@ -65,75 +74,83 @@ the supplied displayname rather than the userid..

- + - +
displaynameThe name to be displayed in CVS changelog.The name to be used in the CVS change log report. Yes
useridThe userid of person as they exist on the CVS server.The userid of the person as it exists on the CVS server. + Yes

Examples

-
  <changelog basedir="dve/network"
+
  <changelog dir="dve/network"
              destfile="changelog.xml"
   />

 
-
Generates a changelog for the dve/network directory including all changes that
-ever occured on repository. It writes these changes into the file "changelog.xml".

+
Generates a change log report for all the changes that have been made
+under the dve/network directory.
+It writes these changes into the file changelog.xml.

 
-
  <changelog basedir="dve/network"
+
  <changelog dir="dve/network"
              destfile="changelog.xml"
              daysinpast="10"
   />

 
-
Generates a changelog for the dve/network directory for the last 10 days. It writes
-these changes into the file "changelog.xml".

+
Generates a change log report for any changes that were made
+under the dve/network directory in the past 10 days.
+It writes these changes into the file changelog.xml.

 
-
  <changelog basedir="dve/network"
+
  <changelog dir="dve/network"
              destfile="changelog.xml"
              start="20 Feb 2002"
              end="20 Mar 2002"
   />

 
-
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 "changelog.xml".

+
Generates a change log report for any changes that were made
+between February 20, 2002 and March 20, 2002
+under the dve/network directory.
+It writes these changes into the file changelog.xml.

 
-
  <changelog basedir="dve/network"
+
  <changelog dir="dve/network"
              destfile="changelog.xml"
              start="20 Feb 2002"
   />

 
-
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 "changelog.xml".

+
Generates a change log report for any changes that were made
+after February 20, 2002 under the dve/network directory.
+It writes these changes into the file changelog.xml.

 
-
  <changelog basedir="dve/network"
-             destfile="changelog.xml"
+
  <changelog dir="dve/network"
+             destfile="changelog.xml"/>
        <user displayname="Peter Donald" userid="donaldp"/>
-  />

+  </changelog>

 
-
Generates a changelog for the dve/network directory for all the changes that
-ever occured. It will also specify the author name as "Peter Donald"
-any time it encounters the username "donaldp" in the changes.

+
Generates a change log report for all the changes that were made
+under the dve/network directory, substituting the name
+"Peter Donald" in the <author> tags
+anytime it encounters a change made by the user ID "donaldp".
+It writes these changes into the file changelog.xml.

 
 
Sample Output

 
 <changelog>
-	<entry>
-		<date>2002-03-06</date>
-		<time>12:00</time>
-		<author>donaldp</author>
-		<file>
-			<name>org/apache/myrmidon/build/AntlibDescriptorTask.java</name>
-			<revision>1.3</revision>
-			<prevrevision>1.2</prevrevision>
-		</file>
-		<msg><![CDATA[Use URLs directly rather than go via a FIle.
+  <entry>
+    <date>2002-03-06</date>
+    <time>12:00</time>
+    <author>Peter Donald</author>
+    <file>
+      <name>org/apache/myrmidon/build/AntlibDescriptorTask.java</name>
+      <revision>1.3</revision>
+      <prevrevision>1.2</prevrevision>
+    </file>
+    <msg><![CDATA[Use URLs directly rather than go via a FIle.
 
 This allows temp[lates to be stored inside jar]]></msg>
-	</entry>
+  </entry>
 </changelog>
 

 
diff --git a/docs/manual/coretasklist.html b/docs/manual/coretasklist.html
index 5c2083045..3740bbf37 100644
--- a/docs/manual/coretasklist.html
+++ b/docs/manual/coretasklist.html
@@ -19,9 +19,10 @@
 Apply/ExecOn

 Available

 Basename

+BuildNumber

 BUnzip2

 BZip2

-Changelog

+ChangeLog

 Checksum

 Chmod

 Condition

diff --git a/docs/manual/tasksoverview.html b/docs/manual/tasksoverview.html
index 06e8a5b37..da6cad704 100644
--- a/docs/manual/tasksoverview.html
+++ b/docs/manual/tasksoverview.html
@@ -819,6 +819,11 @@ documentation.

     
Sets a property to the last element of a specified path.
   
 
+  
+    BuildNumber
+    
Task that can be used to track build numbers.
+  
+
   
     Condition
     
Sets a property if a certain condition holds true - this is a
@@ -923,6 +928,13 @@ documentation.

     Description
   
 
+  
+    ChangeLog
+    
Generates an XML report of the changes recorded in a
+     CVS
+     repository.

+  
+
   
     Cvs
     
Handles packages/modules retrieved from a