| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <html> |
| |
| <head> |
| <meta http-equiv="Content-Language" content="en-us"> |
| <title>ChangeLog Task</title> |
| </head> |
| |
| <body> |
| |
| <h2><a name="changelog">ChangeLog</a></h2> |
| <h3>Description</h3> |
| |
| <p>Generates an XML-formatted report file of the change logs recorded |
| in a <a href="http://subversion.tigris.org/" |
| target="_top">Subversion</a> repository. </p> |
| |
| <p><b>Important:</b> This task needs "svn" on the path. If it isn't, |
| you will get an error (such as error 2 on windows). If |
| <code><svn></code> doesn't work, try to execute svn.exe from the |
| command line in the target directory in which you are working.</p> |
| |
| <h3>Parameters</h3> |
| <table border="1" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td valign="top"><b>Attribute</b></td> |
| <td valign="top"><b>Description</b></td> |
| <td align="center" valign="top"><b>Required</b></td> |
| </tr> |
| <tr> |
| <td colspan="3">Attributes from parent <a href="svn.html">svn |
| task</a> which are meaningful here<br/> |
| </tr> |
| <tr> |
| <td valign="top">svnURL</td> |
| <td valign="top">the URL the subcommand should apply to.</td> |
| <td align="center" valign="top">No</td> |
| </tr> |
| <tr> |
| <td valign="top">dest</td> |
| <td valign="top">the directory where the checked out files are.</td> |
| <td align="center" valign="top">No, default is project's basedir.</td> |
| </tr> |
| <tr> |
| <td valign="top">failonerror</td> |
| <td valign="top">Stop the build process if the command exits with a |
| return code other than <code>0</code>. Defaults to false</td> |
| <td align="center" valign="top">No</td> |
| </tr> |
| <tr> |
| <td colspan="3">Specific attributes</td> |
| </tr> |
| <tr> |
| <td valign="top">dir</td> |
| <td valign="top">The directory from which to run the SVN <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 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 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 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 revision/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 revision/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 nested <code><user></code> element allows you to specify |
| a mapping between a user ID as it appears on the Subversion server and |
| a name to include in the formatted report. Anytime the specified user |
| ID has made a change in the repository, the |
| <code><author></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> |
| <td valign="top"><b>Attribute</b></td> |
| <td valign="top"><b>Description</b></td> |
| <td align="center" valign="top"><b>Required</b></td> |
| </tr> |
| <tr> |
| <td valign="top">displayname</td> |
| <td valign="top">The name to be used in the Subversion change log |
| report.</td> |
| <td valign="top" align="center">Yes</td> |
| </tr> |
| <tr> |
| <td valign="top">userid</td> |
| <td valign="top">The userid of the person as it exists on the |
| Subversion server. |
| </td> |
| <td valign="top" align="center">Yes</td> |
| </tr> |
| </table> |
| |
| |
| <h3>Examples</h3> |
| <pre> <changelog dir="dve/network" |
| destfile="changelog.xml" |
| /></pre> |
| |
| <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> <changelog dir="dve/network" |
| destfile="changelog.xml" |
| daysinpast="10" |
| /></pre> |
| |
| <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> <changelog dir="dve/network" |
| destfile="changelog.xml" |
| start="{2002-02-20}" |
| end="{2002-03-20}" |
| /></pre> |
| |
| <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> <changelog dir="dve/network" |
| destfile="changelog.xml" |
| start="{2002-02-20}" |
| /></pre> |
| |
| <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> <changelog dir="dve/network" |
| destfile="changelog.xml" |
| start="1000" |
| end="1500" |
| /></pre> |
| |
| <p>Generates a change log report for any changes that were made |
| between Subversion revisions 1000 and 1500 under the |
| <code>dve/network</code> directory. It writes these changes into the |
| file <code>changelog.xml</code>.</p> |
| |
| <pre> <changelog dir="dve/network" |
| destfile="changelog.xml"> |
| <user displayname="Esmerelda Weatherwax" userid="granny"/> |
| </changelog></pre> |
| |
| <p>Generates a change log report for all the changes that were made |
| under the <code>dve/network</code> directory, substituting the name |
| "Esmerelda Weatherwax" in the <code><author></code> tags |
| anytime it encounters a change made by the user ID "granny". |
| It writes these changes into the file <code>changelog.xml</code>.</p> |
| |
| <h4>Generate Report</h4> |
| <p>This antlib includes a basic XSLT stylesheet that you can use to |
| generate a HTML report based on the xml output. The following example |
| illustrates how to generate a HTML report from the XML report.</p> |
| |
| <pre> |
| <style in="changelog.xml" |
| out="changelog.html" |
| style="your-path-to/etc/changelog.xsl"> |
| <param name="title" expression="Jakarta BCEL ChangeLog"/> |
| <param name="repo" expression="http://svn.apache.org/repos/asf"/> |
| </style> |
| </pre> |
| |
| <h4>Sample Output</h4> |
| <pre> |
| <entry> |
| <date>2005-02-14</date> |
| <time>01:55</time> |
| <author><![CDATA[dbrosius]]></author> |
| <revision>153687</revision> |
| <path> |
| <name><![CDATA[/jakarta/bcel/trunk/src/java/org/apache/bcel/util/BCELifier.java]]></name> |
| <action>modified</action> |
| </path> |
| <message><![CDATA[Update BCELifier to handle the new method access flags (ACC_BRIDGE, ACC_VARARGS)]]></message> |
| </entry> |
| </pre> |
| |
| |
| |
| </body> |
| </html> |
