| 1 | <!--
|
|---|
| 2 | Licensed to the Apache Software Foundation (ASF) under one or more
|
|---|
| 3 | contributor license agreements. See the NOTICE file distributed with
|
|---|
| 4 | this work for additional information regarding copyright ownership.
|
|---|
| 5 | The ASF licenses this file to You under the Apache License, Version 2.0
|
|---|
| 6 | (the "License"); you may not use this file except in compliance with
|
|---|
| 7 | the License. You may obtain a copy of the License at
|
|---|
| 8 |
|
|---|
| 9 | http://www.apache.org/licenses/LICENSE-2.0
|
|---|
| 10 |
|
|---|
| 11 | Unless required by applicable law or agreed to in writing, software
|
|---|
| 12 | distributed under the License is distributed on an "AS IS" BASIS,
|
|---|
| 13 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|---|
| 14 | See the License for the specific language governing permissions and
|
|---|
| 15 | limitations under the License.
|
|---|
| 16 | -->
|
|---|
| 17 | <html>
|
|---|
| 18 |
|
|---|
| 19 | <head>
|
|---|
| 20 | <meta http-equiv="Content-Language" content="en-us">
|
|---|
| 21 | <link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
|---|
| 22 | <title>ChangeLog Task</title>
|
|---|
| 23 | </head>
|
|---|
| 24 |
|
|---|
| 25 | <body>
|
|---|
| 26 |
|
|---|
| 27 | <h2><a name="changelog">CvsChangeLog</a></h2>
|
|---|
| 28 | <h3>Description</h3>
|
|---|
| 29 | <p>Generates an XML-formatted report file of the change logs recorded in a
|
|---|
| 30 | <a href="http://www.nongnu.org/cvs/" target="_top">CVS</a> repository. </p>
|
|---|
| 31 | <p><b>Important:</b> This task needs "cvs" on the path. If it isn't, you will get
|
|---|
| 32 | an error (such as error 2 on windows). If <code><cvs></code> doesn't work, try to execute cvs.exe
|
|---|
| 33 | from the command line in the target directory in which you are working.
|
|---|
| 34 | <h3>Parameters</h3>
|
|---|
| 35 | <table border="1" cellpadding="2" cellspacing="0">
|
|---|
| 36 | <tr>
|
|---|
| 37 | <td valign="top"><b>Attribute</b></td>
|
|---|
| 38 | <td valign="top"><b>Description</b></td>
|
|---|
| 39 | <td align="center" valign="top"><b>Required</b></td>
|
|---|
| 40 | </tr>
|
|---|
| 41 | <tr>
|
|---|
| 42 | <td colspan="3">Attributes from parent Cvs task which are meaningful here<br>
|
|---|
| 43 | Since ant 1.6.1</td>
|
|---|
| 44 | </tr>
|
|---|
| 45 | <tr>
|
|---|
| 46 | <td valign="top">cvsRoot</td>
|
|---|
| 47 | <td valign="top">the <code>CVSROOT</code> variable.</td>
|
|---|
| 48 | <td align="center" valign="top">No</td>
|
|---|
| 49 | </tr>
|
|---|
| 50 | <tr>
|
|---|
| 51 | <td valign="top">cvsRsh</td>
|
|---|
| 52 | <td valign="top">the <code>CVS_RSH</code> variable.</td>
|
|---|
| 53 | <td align="center" valign="top">No</td>
|
|---|
| 54 | </tr>
|
|---|
| 55 | <tr>
|
|---|
| 56 | <td valign="top">package</td>
|
|---|
| 57 | <td valign="top">the package/module to check out.</td>
|
|---|
| 58 | <td align="center" valign="top">No</td>
|
|---|
| 59 | </tr>
|
|---|
| 60 | <tr>
|
|---|
| 61 | <td valign="top">port</td>
|
|---|
| 62 | <td valign="top">Port used by CVS to communicate with the server.</td>
|
|---|
| 63 | <td align="center" valign="top">No, default port 2401.</td>
|
|---|
| 64 | </tr>
|
|---|
| 65 | <tr>
|
|---|
| 66 | <td valign="top">passfile</td>
|
|---|
| 67 | <td valign="top">Password file to read passwords from.</td>
|
|---|
| 68 | <td align="center" valign="top">No, default file <code>~/.cvspass</code>.</td>
|
|---|
| 69 | </tr>
|
|---|
| 70 | <tr>
|
|---|
| 71 | <td valign="top">failonerror</td>
|
|---|
| 72 | <td valign="top">Stop the build process if the command exits with a
|
|---|
| 73 | return code other than <code>0</code>. Defaults to false</td>
|
|---|
| 74 | <td align="center" valign="top">No</td>
|
|---|
| 75 | </tr>
|
|---|
| 76 | <tr>
|
|---|
| 77 | <td valign="top">tag</td>
|
|---|
| 78 | <td valign="top">query the changelog for a specific branch.</td>
|
|---|
| 79 | <td align="center" valign="top">No</td>
|
|---|
| 80 | </tr>
|
|---|
| 81 | <tr>
|
|---|
| 82 | <td colspan="3">Specific attributes</td>
|
|---|
| 83 | </tr>
|
|---|
| 84 | <tr>
|
|---|
| 85 | <td valign="top">dir</td>
|
|---|
| 86 | <td valign="top">The directory from which to run the CVS <em>log</em>
|
|---|
| 87 | command.</td>
|
|---|
| 88 | <td align="center" valign="top">No; defaults to ${basedir}.</td>
|
|---|
| 89 | </tr>
|
|---|
| 90 | <tr>
|
|---|
| 91 | <td valign="top">destfile</td>
|
|---|
| 92 | <td valign="top">The file in which to write the change log report.</td>
|
|---|
| 93 | <td align="center" valign="top">Yes</td>
|
|---|
| 94 | </tr>
|
|---|
| 95 | <tr>
|
|---|
| 96 | <td valign="top">usersfile</td>
|
|---|
| 97 | <td valign="top">Property file that contains name-value pairs mapping
|
|---|
| 98 | user IDs and names that should be used in the report in place of
|
|---|
| 99 | the user ID.</td>
|
|---|
| 100 | <td align="center" valign="top">No</td>
|
|---|
| 101 | </tr>
|
|---|
| 102 | <tr>
|
|---|
| 103 | <td valign="top">daysinpast</td>
|
|---|
| 104 | <td valign="top">Sets the number of days into the past for which the
|
|---|
| 105 | change log information should be retrieved.</td>
|
|---|
| 106 | <td align="center" valign="top">No</td>
|
|---|
| 107 | </tr>
|
|---|
| 108 | <tr>
|
|---|
| 109 | <td valign="top">start</td>
|
|---|
| 110 | <td valign="top">The earliest date from which change logs are to be
|
|---|
| 111 | included in the report.</td>
|
|---|
| 112 | <td align="center" valign="top">No</td>
|
|---|
| 113 | </tr>
|
|---|
| 114 | <tr>
|
|---|
| 115 | <td valign="top">end</td>
|
|---|
| 116 | <td valign="top">The latest date to which change logs are to be
|
|---|
| 117 | included in the report.</td>
|
|---|
| 118 | <td align="center" valign="top">No</td>
|
|---|
| 119 | </tr>
|
|---|
| 120 | </table>
|
|---|
| 121 |
|
|---|
| 122 | <h3>Parameters specified as nested elements</h3>
|
|---|
| 123 | <h4><a name="user">user</a></h4>
|
|---|
| 124 | <p>The nested <code><user></code> element allows you to specify a
|
|---|
| 125 | mapping between a user ID as it appears on the CVS server and a name to
|
|---|
| 126 | include in the formatted report.
|
|---|
| 127 | Anytime the specified user ID has made a change in the repository, the
|
|---|
| 128 | <code><author></code> tag in the report file will include
|
|---|
| 129 | the name specified in <code>displayname</code> rather than the user ID.
|
|---|
| 130 | </p>
|
|---|
| 131 |
|
|---|
| 132 | <table border="1" cellpadding="2" cellspacing="0">
|
|---|
| 133 | <tr>
|
|---|
| 134 | <td valign="top"><b>Attribute</b></td>
|
|---|
| 135 | <td valign="top"><b>Description</b></td>
|
|---|
| 136 | <td align="center" valign="top"><b>Required</b></td>
|
|---|
| 137 | </tr>
|
|---|
| 138 | <tr>
|
|---|
| 139 | <td valign="top">displayname</td>
|
|---|
| 140 | <td valign="top">The name to be used in the CVS change log report.</td>
|
|---|
| 141 | <td valign="top" align="center">Yes</td>
|
|---|
| 142 | </tr>
|
|---|
| 143 | <tr>
|
|---|
| 144 | <td valign="top">userid</td>
|
|---|
| 145 | <td valign="top">The userid of the person as it exists on the CVS server.
|
|---|
| 146 | </td>
|
|---|
| 147 | <td valign="top" align="center">Yes</td>
|
|---|
| 148 | </tr>
|
|---|
| 149 | </table>
|
|---|
| 150 |
|
|---|
| 151 |
|
|---|
| 152 | <h3>Examples</h3>
|
|---|
| 153 | <pre> <cvschangelog dir="dve/network"
|
|---|
| 154 | destfile="changelog.xml"
|
|---|
| 155 | /></pre>
|
|---|
| 156 |
|
|---|
| 157 | <p>Generates a change log report for all the changes that have been made
|
|---|
| 158 | under the <code>dve/network</code> directory.
|
|---|
| 159 | It writes these changes into the file <code>changelog.xml</code>.</p>
|
|---|
| 160 |
|
|---|
| 161 | <pre> <cvschangelog dir="dve/network"
|
|---|
| 162 | destfile="changelog.xml"
|
|---|
| 163 | daysinpast="10"
|
|---|
| 164 | /></pre>
|
|---|
| 165 |
|
|---|
| 166 | <p>Generates a change log report for any changes that were made
|
|---|
| 167 | under the <code>dve/network</code> directory in the past 10 days.
|
|---|
| 168 | It writes these changes into the file <code>changelog.xml</code>.</p>
|
|---|
| 169 |
|
|---|
| 170 | <pre> <cvschangelog dir="dve/network"
|
|---|
| 171 | destfile="changelog.xml"
|
|---|
| 172 | start="20 Feb 2002"
|
|---|
| 173 | end="20 Mar 2002"
|
|---|
| 174 | /></pre>
|
|---|
| 175 |
|
|---|
| 176 | <p>Generates a change log report for any changes that were made
|
|---|
| 177 | between February 20, 2002 and March 20, 2002
|
|---|
| 178 | under the <code>dve/network</code> directory.
|
|---|
| 179 | It writes these changes into the file <code>changelog.xml</code>.</p>
|
|---|
| 180 |
|
|---|
| 181 | <pre> <cvschangelog dir="dve/network"
|
|---|
| 182 | destfile="changelog.xml"
|
|---|
| 183 | start="20 Feb 2002"
|
|---|
| 184 | /></pre>
|
|---|
| 185 |
|
|---|
| 186 | <p>Generates a change log report for any changes that were made
|
|---|
| 187 | after February 20, 2002 under the <code>dve/network</code> directory.
|
|---|
| 188 | It writes these changes into the file <code>changelog.xml</code>.</p>
|
|---|
| 189 |
|
|---|
| 190 | <pre> <cvschangelog dir="dve/network"
|
|---|
| 191 | destfile="changelog.xml">
|
|---|
| 192 | <user displayname="Peter Donald" userid="donaldp"/>
|
|---|
| 193 | </cvschangelog></pre>
|
|---|
| 194 |
|
|---|
| 195 | <p>Generates a change log report for all the changes that were made
|
|---|
| 196 | under the <code>dve/network</code> directory, substituting the name
|
|---|
| 197 | "Peter Donald" in the <code><author></code> tags
|
|---|
| 198 | anytime it encounters a change made by the user ID "donaldp".
|
|---|
| 199 | It writes these changes into the file <code>changelog.xml</code>.</p>
|
|---|
| 200 |
|
|---|
| 201 | <p>Generates a change log report on the <code>ANT_16_BRANCH</code>.</p>
|
|---|
| 202 | <pre>
|
|---|
| 203 | <cvschangelog dir="c:/dev/asf/ant.head" passfile="c:/home/myself/.cvspass"
|
|---|
| 204 | destfile="changelogant.xml" tag="ANT_16_BRANCH"/>
|
|---|
| 205 | </pre>
|
|---|
| 206 | <h4>Generate Report</h4>
|
|---|
| 207 | <p>Ant includes a basic XSLT stylesheet that you can use to generate
|
|---|
| 208 | a HTML report based on the xml output. The following example illustrates
|
|---|
| 209 | how to generate a HTML report from the XML report.</p>
|
|---|
| 210 |
|
|---|
| 211 | <pre>
|
|---|
| 212 | <style in="changelog.xml"
|
|---|
| 213 | out="changelog.html"
|
|---|
| 214 | style="${ant.home}/etc/changelog.xsl">
|
|---|
| 215 | <param name="title" expression="Ant ChangeLog"/>
|
|---|
| 216 | <param name="module" expression="ant"/>
|
|---|
| 217 | <param name="cvsweb" expression="http://cvs.apache.org/viewcvs/"/>
|
|---|
| 218 | </style>
|
|---|
| 219 | </pre>
|
|---|
| 220 |
|
|---|
| 221 | <h4>Sample Output</h4>
|
|---|
| 222 | <pre>
|
|---|
| 223 | <changelog>
|
|---|
| 224 | <entry>
|
|---|
| 225 | <date>2002-03-06</date>
|
|---|
| 226 | <time>12:00</time>
|
|---|
| 227 | <author>Peter Donald</author>
|
|---|
| 228 | <file>
|
|---|
| 229 | <name>org/apache/myrmidon/build/AntlibDescriptorTask.java</name>
|
|---|
| 230 | <revision>1.3</revision>
|
|---|
| 231 | <prevrevision>1.2</prevrevision>
|
|---|
| 232 | </file>
|
|---|
| 233 | <msg><![CDATA[Use URLs directly rather than go via a File.
|
|---|
| 234 |
|
|---|
| 235 | This allows templates to be stored inside jar]]></msg>
|
|---|
| 236 | </entry>
|
|---|
| 237 | </changelog>
|
|---|
| 238 | </pre>
|
|---|
| 239 |
|
|---|
| 240 |
|
|---|
| 241 |
|
|---|
| 242 | </body>
|
|---|
| 243 | </html>
|
|---|
| 244 |
|
|---|
