Skip to content

Commit 2b7190a

Browse files
committed
Improving release notes so they discuss the backwards compatibility issues
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/cli/trunk@546604 13f79535-47bb-0310-9956-ffa450edef68
1 parent 3832c03 commit 2b7190a

3 files changed

Lines changed: 49 additions & 1 deletion

File tree

xdocs/index.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The <a href="cvs-usage.html">subversion repository</a> can be
6868
<p>
6969
The latest version is v1.1. -
7070
<a href="http://jakarta.apache.org/site/downloads/downloads_commons-cli.cgi">Download now!</a><br />
71-
The <a href="changes-report.html#1_1">release notes</a> are also available.
71+
The <a href="upgrading-1.0-to-1.1.html">release notes</a> are also available.
7272
</p>
7373
<p>
7474
For previous releases, see the <a href="http://archive.apache.org/dist/jakarta/commons/cli/">Apache Archive</a>

xdocs/navigation.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
<item name="Getting started" href="/introduction.html"/>
3737
<item name="Usage scenarios" href="/usage.html"/>
3838
<item name="Option properties" href="/properties.html"/>
39+
<item name="Upgrading to 1.1" href="/upgrading-1.0-to-1.1.html"/>
3940
<item name="Javadoc (1.1)" href="api-release/index.html"/>
4041
</menu>
4142

xdocs/upgrading-1.0-to-1.1.xml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<?xml version="1.0"?>
2+
<!--
3+
Licensed to the Apache Software Foundation (ASF) under one or more
4+
contributor license agreements. See the NOTICE file distributed with
5+
this work for additional information regarding copyright ownership.
6+
The ASF licenses this file to You under the Apache License, Version 2.0
7+
(the "License"); you may not use this file except in compliance with
8+
the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing, software
13+
distributed under the License is distributed on an "AS IS" BASIS,
14+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
See the License for the specific language governing permissions and
16+
limitations under the License.
17+
-->
18+
<document>
19+
<properties>
20+
<title>Upgrading from 1.0 to 1.1</title>
21+
<author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
22+
</properties>
23+
<body>
24+
<!-- ================================================== -->
25+
<section name="Upgrading from 1.0 to 1.1">
26+
<p>CLI 1.1 is a bugfix release of CLI. The following changes were not backward compatible: </p>
27+
28+
<ul>
29+
<li>The CommandLineParser interface has two additional methods. If you were extending this,
30+
then you will need to add methods to your classes. If you were extending the abstract
31+
Parser class, then you should be okay. </li>
32+
<li>The HelpFormatter class had publicly accessible fields. These are now accessed via
33+
get/set methods. </li>
34+
<li>Two of HelpFormatter's methods no longer throw IllegalArgumentException. </li>
35+
<li>The Option class is no longer cloneable, and no longer has an addValue(String) method. </li>
36+
</ul>
37+
38+
<p>The best way to test any of the above is to recompile your code against CLI 1.1. All of the above
39+
should result in compile time errors. </p>
40+
</section>
41+
<section name="Bugs fixed in 1.1">
42+
<p>The list of bugs fixed in 1.1 may be seen via the
43+
<a href="changes-report.html#1_1">changes report</a>. </p>
44+
</section>
45+
<!-- ================================================== -->
46+
</body>
47+
</document>

0 commit comments

Comments
 (0)