xref: /aosp_15_r20/external/apache-commons-bcel/src/changes/release-notes.vm (revision 0c56280ab0842982c46a149f7b9eaa497e31e292)
1## Licensed to the Apache Software Foundation (ASF) under one
2## or more contributor license agreements.  See the NOTICE file
3## distributed with this work for additional information
4## regarding copyright ownership.  The ASF licenses this file
5## to you under the Apache License, Version 2.0 (the
6## "License"); you may not use this file except in compliance
7## with 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,
12## software distributed under the License is distributed on an
13## "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14## KIND, either express or implied.  See the License for the
15## specific language governing permissions and limitations
16## under the License.
17##
18              ${project.name}
19                  Version ${version}
20                RELEASE NOTES
21
22
23INTRODUCTION:
24
25The ${developmentTeam} is pleased to announce the release of
26${project.name} ${version}!
27
28The Byte Code Engineering Library (BCEL) is intended to give users a convenient
29way to analyze, create, and manipulate compiled .class files. Classes are
30represented by objects containing all the symbolic information of the given
31class: methods, fields and byte code instructions.
32
33##$introduction.replaceAll("(?<!\015)\012", "
34##").replaceAll("(?m)^ +","")
35##
36## N.B. the available variables are described here:
37## http://maven.apache.org/plugins/maven-changes-plugin/examples/using-a-custom-announcement-template.html
38##
39## Hack to improve layout: replace all pairs of spaces with a single new-line
40$release.description.replaceAll("  ", "
41")
42
43## set up indent sizes. Only change indent1
44#set($props=${project.properties})
45#set($jiralen=$props.get("commons.jira.id").length())
46## indent1 =   POOL-nnnn:
47#set($blanklen=$jiralen+5)## +6 for "-nnn:"
48## must be at least as long as the longest JIRA id
49#set($blanks="                                  ")
50#set($indent1=$blanks.substring(0,$blanklen))
51## indent2 allows for issue wrapper
52#set($indent2="$indent1   ")
53##
54#macro ( processaction )
55## Use replaceAll to fix up LF-only line ends on Windows.
56#set($action=$actionItem.getAction().replaceAll("\n","
57"))
58## Replace &lt; with < so can embed tag markup
59#set($action=$action.replaceAll("&lt;","<"))
60## use an empty date to mean don't format the entry
61## TODO how to enable leading spaces without compromising html report
62## unfortunately leading spaces are trimmed even from CDATA sections
63#if ($actionItem.getDate() && $actionItem.getDate().length()==0)
64$action
65#else
66## Fix up indentation for multi-line action descriptions
67#set($action=$action.replaceAll("(?m)^  +",$indent2))
68#if ($actionItem.getIssue())
69#set($issue="$actionItem.getIssue():")
70## Pad shorter issue numbers
71#if ($issue.length() < $indent1.length())#set ($issue="$issue ")#end
72#if ($issue.length() < $indent1.length())#set ($issue="$issue ")#end
73#if ($issue.length() < $indent1.length())#set ($issue="$issue ")#end
74#else
75#set($issue=$indent1)
76#end
77#if ($actionItem.getDueTo())
78#set($dueto=" Thanks to $actionItem.getDueTo().")
79#else
80#set($dueto="")
81#end
82o $issue ${action}$dueto
83#end
84#set($action="")
85#set($issue="")
86#set($dueto="")
87#end
88##
89#if ($release.getActions().size() == 0)
90No changes defined in this version.
91#else
92#if ($release.getActions('add').size() !=0)
93NEW FEATURES:
94=============
95
96#foreach($actionItem in $release.getActions('add'))
97#processaction()
98#end
99
100#end
101##
102#if ($release.getActions('fix').size() !=0)
103FIXED BUGS:
104===========
105
106#foreach($actionItem in $release.getActions('fix'))
107#processaction()
108#end
109
110#end
111##
112#if ($release.getActions('update').size() !=0)
113CHANGES:
114========
115
116#foreach($actionItem in $release.getActions('update'))
117#processaction()
118#end
119
120#end
121##
122#if ($release.getActions('remove').size() !=0)
123REMOVED:
124========
125#foreach($actionItem in $release.getActions('remove'))
126#processaction()
127#end
128#end
129## End of main loop
130#end
131
132
133Have fun!
134-Apache Commons BCEL team
135
136Feedback
137--------
138
139Open source works best when you give feedback:
140
141    http://commons.apache.org/bcel
142
143Please direct all bug reports to JIRA:
144
145    https://issues.apache.org/jira/browse/BCEL
146
147Or subscribe to the commons-user mailing list
148
149The Apache Commons Team
150