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