1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
|
<!--
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">
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>ChangeLog Task</title>
</head>
<body>
<h2><a name="changelog">CvsChangeLog</a></h2>
<h3>Description</h3>
<p>Generates an XML-formatted report file of the change logs recorded in a
<a href="http://www.nongnu.org/cvs/" target="_top">CVS</a> repository. </p>
<p><b>Important:</b> This task needs "<code>cvs</code>" on the path. If it isn't, you will get
an error (such as error <code>2</code> on windows). If <code><cvs></code> doesn't work, try to execute <code>cvs.exe</code>
from the command line in the target directory in which you are working.
Also note that this task assumes that the cvs executable is compatible
with the Unix version from cvshome.org, this is not completely true
for certain other cvs clients - like CVSNT for example - and some
operation may fail when using such an incompatible client.
</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 Cvs task which are meaningful here<br>
Since Apache Ant 1.6.1</td>
</tr>
<tr>
<td valign="top">cvsRoot</td>
<td valign="top">the <code>CVSROOT</code> variable.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">cvsRsh</td>
<td valign="top">the <code>CVS_RSH</code> variable.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">package</td>
<td valign="top">the package/module to check out. <b>Note:</b>
multiple attributes can be split using spaces. Use a nested
<module> element if you want to specify a module with
spaces in its name.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">port</td>
<td valign="top">Port used by CVS to communicate with the server.</td>
<td align="center" valign="top">No, default port 2401.</td>
</tr>
<tr>
<td valign="top">passfile</td>
<td valign="top">Password file to read passwords from.</td>
<td align="center" valign="top">No, default file <code>~/.cvspass</code>.</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 valign="top">tag</td>
<td valign="top">query the changelog for a specific branch.</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 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 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 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 to which change logs are to be
included in the report.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">remote</td>
<td valign="top">If set to true, works against the repository
(using rlog) without a working copy. Default is
false. <em>Since Ant 1.8.0</em></td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">startTag</td>
<td valign="top">The start of a tag range. If endTag is also
specified, they must both be on the same branch. If endTag is not
specified, the end of the range will be the latest on the same
branch on which startTag lives. <em>Since Ant 1.8.0</em></td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">endTag</td>
<td valign="top">The end of a tag range. If startTag is also
specified, they must both be on the same branch. If startTag is
not specified, the start of the range will be the top of the
branch on which endTag lives.</td> included in the report.
<em>Since Ant 1.8.0</em></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 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><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 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 the person as it exists on the CVS server.
</td>
<td valign="top" align="center">Yes</td>
</tr>
</table>
<h4>module</h4>
<p>Specifies a package/module to work on, unlike the package attribute
modules specified using this attribute can contain spaces in their
name.</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">name</td>
<td valign="top">The module's/package's name.</td>
<td align="center" valign="top">Yes.</td>
</tr>
</table>
<h3>Examples</h3>
<pre> <cvschangelog 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> <cvschangelog 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> <cvschangelog dir="dve/network"
destfile="changelog.xml"
start="20 Feb 2002"
end="20 Mar 2002"
/></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> <cvschangelog dir="dve/network"
destfile="changelog.xml"
start="20 Feb 2002"
/></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> <cvschangelog dir="dve/network"
destfile="changelog.xml">
<user displayname="Peter Donald" userid="donaldp"/>
</cvschangelog></pre>
<p>Generates a change log report for all the changes that were made
under the <code>dve/network</code> directory, substituting the name
"Peter Donald" in the <code><author></code> tags
anytime it encounters a change made by the user ID "donaldp".
It writes these changes into the file <code>changelog.xml</code>.</p>
<p>Generates a change log report on the <code>ANT_16_BRANCH</code>.</p>
<pre>
<cvschangelog dir="c:/dev/asf/ant.head" passfile="c:/home/myself/.cvspass"
destfile="changelogant.xml" tag="ANT_16_BRANCH"/>
</pre>
<h4>Generate Report</h4>
<p>Ant 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="${ant.home}/etc/changelog.xsl">
<param name="title" expression="Ant ChangeLog"/>
<param name="module" expression="ant"/>
<param name="cvsweb" expression="http://cvs.apache.org/viewcvs/"/>
</style>
</pre>
<h4>Sample Output</h4>
<pre>
<changelog>
<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 templates to be stored inside jar]]></msg>
</entry>
</changelog>
</pre>
</body>
</html>
|
