You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by tn...@apache.org on 2013/02/12 14:31:58 UTC
svn commit: r1445165 - in /commons/proper/cli/trunk: RELEASE-NOTES.txt
src/changes/changes.xml
Author: tn
Date: Tue Feb 12 13:31:58 2013
New Revision: 1445165
URL: http://svn.apache.org/r1445165
Log:
Update release notes.
Modified:
commons/proper/cli/trunk/RELEASE-NOTES.txt
commons/proper/cli/trunk/src/changes/changes.xml
Modified: commons/proper/cli/trunk/RELEASE-NOTES.txt
URL: http://svn.apache.org/viewvc/commons/proper/cli/trunk/RELEASE-NOTES.txt?rev=1445165&r1=1445164&r2=1445165&view=diff
==============================================================================
--- commons/proper/cli/trunk/RELEASE-NOTES.txt (original)
+++ commons/proper/cli/trunk/RELEASE-NOTES.txt Tue Feb 12 13:31:58 2013
@@ -1,7 +1,7 @@
$Id$
Commons CLI Package
- Version 1.2
+ Version 1.3
Release Notes
@@ -11,70 +11,81 @@ This document contains the release notes
package. Commons CLI provides a simple API for working with the command line
arguments and options.
-Commons CLI 1.2 is a bugfix release. The following notable changes were made:
-
- * A major regression introduced in CLI 1.1 that prevented the usage of repeated options has been fixed.
- * Several parser issues have been fixed, especially with the PosixParser.
- * HelpFormatter now wraps the lines properly
- * The ordering of the option in the help message can now be defined.
- * Various API enhancements (improved exceptions, serializable classes)
-
-Commons CLI 1.2 is binary compatible with the previous versions, except for
-the OptionValidator class that is no longer public.
+Commons CLI 1.3 is a bugfix release and binary compatible with the previous versions,
+except for the OptionValidator class that is no longer public (change introduced in v1.2).
More information can be found on the project site at http://commons.apache.org/cli
NEW FEATURES:
- * The method getOptionProperties() in the CommandLine class was added
- to retrieve easily the key/value pairs specified with options like
- -Dkey1=value1 -Dkey2=value2.
+ * Added new fluent API to create Option instances via builder class Option.Builder.
+ This replaces the now deprecated OptionBuilder. Thanks to Duncan Jones, Brian Blount. (CLI-224)
- * GnuParser now supports long options with an '=' sign
- (ie. --foo=bar and -foo=bar) (CLI-157)
+ * Added new method Options.addOption(String, String). Thanks to Alexandru Mocanu. (CLI-214)
+
+ * A new parser is available: DefaultParser. It combines the features of the GnuParser and the PosixParser.
+ It also provides additional features like partial matching for the long options, and long options without
+ separator (i.e like the JVM memory settings: -Xmx512m). This new parser deprecates the previous ones.
+ (CLI-161, CLI-167, CLI-181)
- * The ordering of options can be defined in help messages. (CLI-155)
+ * PosixParser now supports partial long options (--ver instead of --version). (CLI-160)
+
+ * HelpFormatter now supports setting the displayed separator of long options. Thanks to J. Lewis Muir. (CLI-169)
BUG FIXES:
- * The number of arguments defined for an option specifies the arguments
- per occurrence of the option and not for all occurrences. (CLI-137)
+ * Default options will now work correctly with required options that are missing. (CLI-202)
- * PosixParser no longer ignores unrecognized short options. (CLI-164)
+ * Default options will now work correctly together with option groups. (CLI-203)
+
+ * HelpFormatter.setArgName(String) now correctly sets the argument name. (CLI-205)
- * PosixParser no longer stops the bursting process of a token if stopAtNonOption
- is enabled and a non option character is encountered. (CLI-163)
+ * Passing default values for not defined options to a parser will now trigger
+ a ParseException instead of a NullPointerException. (CLI-204)
- * PosixParser no longer keeps processing the tokens after an unrecognized
- long option when stopAtNonOption is enabled. (CLI-165)
+ * Default properties provided as input to the Parser.parse() methods are now
+ correctly processed. (CLI-201)
- * Required options are properly checked if an Options instance is used twice
- to parse a command line. (CLI-156)
+ * CommandLine.getParsedOptionValue() now returns a String object if no
+ option type has been explicitly set. Thanks to Manuel Müller. (CLI-215)
+
+ * HelpFormatter now prints command-line options in the same order as they
+ have been added. Thanks to Per Cederberg. (CLI-212)
- * The line wrapping in HelpFormatter now works properly. (CLI-151) (CLI-162)
+ * Standard help text now shows mandatory arguments also for the first option. Thanks to Kristoff Kiefer. (CLI-186)
- * OptionBuilder is now reset back to a blank state when it throws an
- Exception. (CLI-177)
+ * HelpFormatter does not strip anymore leading whitespace in the footer text. Thanks to Uri Moszkowicz. (CLI-207)
+ * Strip quotes contained in argument values only if there is exactly one at the
+ beginning and one at the end. Thanks to Einar M R Rosenvinge. (CLI-185)
-CHANGES:
+ * Negative numerical arguments take precedence over numerical options. (CLI-184)
- * The message of MissingOptionException has been improved. (CLI-149)
+ * Fix possible StringIndexOutOfBoundsException in HelpFormatter. Thanks to Travis McLeskey. (CLI-193)
- * The exceptions have been enhanced with methods to retrieve easily
- the related options. (CLI-86)
+ * OptionGroups no longer throw an AlreadySelectedException when reused for several parsings. (CLI-183)
+
+ * OptionGroup now selects properly an option with no short name. (CLI-182)
+
+
+CHANGES:
- * Option.toString() now reports arguments properly. (CLI-141)
+ * Options.getRequiredOptions() now returns an unmodifiable list. (CLI-230)
- * The Parser class has been changed to be more easily extendable. (CLI-142)
+ * Clarify javadoc for CommandLine.getOptionValue() that the first specified
+ argument will be returned. Thanks to Sven. (CLI-218)
- * The following classes are now serializable: Option, OptionGroup,
- CommandLine and Options. (CLI-140)
+ * Changed unit tests to junit 4 annotation style. Thanks to Duncan Jones. (CLI-227)
- * OptionValidator is no longer public, its methods were all private.
+ * The javadoc of OptionBuilder now states that the class is not thread-safe. Thanks to Thomas Herre. (CLI-209)
- * TypeHandler no longer prints to stderr. (CLI-170)
+ * Fixed typo in javadoc of class CommandLine. Thanks to Gerard Weatherby. (CLI-200)
+
+ * Source code now uses generic types instead of raw types where possible. Thanks to Gerard Weatherby. (CLI-223)
+ * Corrected javadoc for return type of MissingOptionException.getMissingOptions(). Thanks to Joe Casadonte. (CLI-220)
+ * Improve description of parameter "stopAtNonOption" in method
+ CommandLine.parse(Options, String[], boolean). Thanks to Anders Larsson. (CLI-197)
Modified: commons/proper/cli/trunk/src/changes/changes.xml
URL: http://svn.apache.org/viewvc/commons/proper/cli/trunk/src/changes/changes.xml?rev=1445165&r1=1445164&r2=1445165&view=diff
==============================================================================
--- commons/proper/cli/trunk/src/changes/changes.xml (original)
+++ commons/proper/cli/trunk/src/changes/changes.xml Tue Feb 12 13:31:58 2013
@@ -22,22 +22,22 @@
</properties>
<body>
- <release version="1.3" date="in SVN">
- <action type="fix" dev="tn" issue="CLI-230">
+ <release version="1.3" date="in SVN" description="This is a maintenance release containing bug fixes.">
+ <action type="update" dev="tn" issue="CLI-230">
Options.getRequiredOptions() now returns an unmodifiable list.
</action>
<action type="add" dev="tn" issue="CLI-224" due-to="Duncan Jones, Brian Blount">
Added new fluent API to create Option instances via builder class Option.Builder.
This replaces the now deprecated OptionBuilder.
</action>
- <action type="fix" dev="tn" issue="CLI-218" due-to="Sven">
+ <action type="update" dev="tn" issue="CLI-218" due-to="Sven">
Clarify javadoc for CommandLine.getOptionValue() that the first specified
argument will be returned.
</action>
<action type="add" dev="tn" issue="CLI-214" due-to="Alexandru Mocanu">
Added new method Options.addOption(String, String).
</action>
- <action type="fix" dev="tn" issue="CLI-227" due-to="Duncan Jones">
+ <action type="update" dev="tn" issue="CLI-227" due-to="Duncan Jones">
Changed unit tests to junit 4 annotation style.
</action>
<action type="fix" dev="ebourg" issue="CLI-202">
@@ -46,13 +46,13 @@
<action type="fix" dev="ebourg" issue="CLI-203">
Default options will now work correctly together with option groups.
</action>
- <action type="fix" dev="ebourg" issue="CLI-209" due-to="Thomas Herre">
+ <action type="update" dev="ebourg" issue="CLI-209" due-to="Thomas Herre">
The javadoc of OptionBuilder now states that the class is not thread-safe.
</action>
- <action type="fix" dev="ebourg" issue="CLI-169" due-to="J. Lewis Muir">
+ <action type="add" dev="ebourg" issue="CLI-169" due-to="J. Lewis Muir">
HelpFormatter now supports setting the displayed separator of long options.
</action>
- <action type="fix" dev="ebourg" issue="CLI-197" due-to="Anders Larsson">
+ <action type="update" dev="ebourg" issue="CLI-197" due-to="Anders Larsson">
Improve description of parameter "stopAtNonOption" in method
CommandLine.parse(Options, String[], boolean).
</action>
@@ -71,10 +71,13 @@
CommandLine.getParsedOptionValue() now returns a String object if no
option type has been explicitly set.
</action>
- <action type="fix" dev="ggregory" issue="CLI-200" due-to="Gerard Weatherby">
+ <action type="update" dev="ggregory" issue="CLI-200" due-to="Gerard Weatherby">
Fixed typo in javadoc of class CommandLine.
</action>
- <action type="fix" dev="ebourg" issue="CLI-220" due-to="Joe Casadonte">
+ <action type="update" dev="ebourg" issue="CLI-223" due-to="Gerard Weatherby">
+ Source code now uses generic types instead of raw types where possible.
+ </action>
+ <action type="update" dev="ebourg" issue="CLI-220" due-to="Joe Casadonte">
Corrected javadoc for return type of MissingOptionException.getMissingOptions().
</action>
<action type="fix" dev="ebourg" issue="CLI-212" due-to="Per Cederberg">
@@ -92,12 +95,13 @@
beginning and one at the end.
</action>
<action type="fix" dev="ebourg" issue="CLI-184">
- Negative numerical arguments take precedence over numerical options.
+ Negative numerical arguments take precedence over numerical options (only supported
+ by the new DefaultParser).
</action>
<action type="fix" dev="ebourg" issue="CLI-193" due-to="Travis McLeskey">
Fix possible StringIndexOutOfBoundsException in HelpFormatter.
</action>
- <action type="add" dev="ebourg" issue="CLI-181">
+ <action type="add" dev="ebourg" issue="CLI-161,CLI-167,CLI-181">
A new parser is available: DefaultParser. It combines the features of the GnuParser and the PosixParser.
It also provides additional features like partial matching for the long options, and long options without
separator (i.e like the JVM memory settings: -Xmx512m). This new parser deprecates the previous ones.