Skip to content

Commit 49a9b2e

Browse files
committed
Updating release notes to match the website
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/cli/branches/cli-1.0.x@552600 13f79535-47bb-0310-9956-ffa450edef68
1 parent 53ed912 commit 49a9b2e

1 file changed

Lines changed: 10 additions & 14 deletions

File tree

RELEASE-NOTES.txt

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,20 @@ $Id$
77

88
INTRODUCTION:
99

10-
This document contains the release notes for this version of the Commons
11-
CLI package. Commons CLI provides a simple API for working with the command line arguments and options.
10+
This document contains the release notes for this version of the Commons CLI package. Commons CLI provides a simple API for working with the command line arguments and options.
1211

13-
This is a bugfix release of CLI. Some parts are not backwards compatible:
12+
CLI 1.1 is a bugfix release of CLI. The following changes notable API changes were made:
1413

15-
* The CommandLineParser interface has two additional methods. If you were extending this,
16-
then you will need to add methods to your classes. If you were extending the abstract
17-
Parser class, then you should be okay.
18-
* The HelpFormatter class had publicly accessible fields. These are now accessed via
19-
get/set methods.
20-
* Two of HelpFormatter's methods no longer throw IllegalArgumentException.
21-
* The Option class is no longer cloneable, and no longer has an addValue(String) method.
14+
* The Parser abstract class has two additional parse methods that take a Properties parameter.
15+
* The HelpFormatter class had publicly accessible fields. These should now be accessed via get/set methods and the public fields are deprecated.
16+
* The Option class addValue(String) method now throws UnsupportedOperationException.
17+
* OptionValidator is a newly added class.
18+
* Option's now have equals(Object) and hashCode() methods.
19+
* The Option class also received two new methods, setDescription(String) and hasValueSeparator();boolean.
2220

23-
The best way to test any of the above is to recompile your code against CLI 1.1. All
24-
should result in compile time errors.
21+
The jar should be API backwards compatible, though if you were calling addValue(String) then you won't be happy. Please let us know your use case if that is so.
2522

26-
For more information, read the documentation on the project site at
27-
http://jakarta.apache.org/commons/cli/
23+
For more information, read the documentation on the project site at http://jakarta.apache.org/commons/cli/
2824

2925
NEW FEATURES:
3026

0 commit comments

Comments
 (0)