Prepare CLI release 1.4
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/cli/trunk@1786154 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/NOTICE.txt b/NOTICE.txt
index d2c5af9..02e26d0 100644
--- a/NOTICE.txt
+++ b/NOTICE.txt
@@ -1,5 +1,5 @@
Apache Commons CLI
-Copyright 2001-2016 The Apache Software Foundation
+Copyright 2001-2017 The Apache Software Foundation
This product includes software developed at
The Apache Software Foundation (http://www.apache.org/).
diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt
index e281b87..c77e73b 100644
--- a/RELEASE-NOTES.txt
+++ b/RELEASE-NOTES.txt
@@ -1,5 +1,5 @@
Apache Commons CLI
- Version 1.3.1
+ Version 1.4
Release Notes
@@ -9,13 +9,33 @@
package. Commons CLI provides a simple API for working with the command line
arguments and options.
-Commons CLI 1.3.1 is a bug fix release and binary compatible with the
+Commons CLI 1.4 is a feature release and binary compatible with the
previous versions, except for the OptionValidator class that is no longer public
-(change introduced in v1.2). Commons CLI 1.3.1 at least requires Java 5.0.
+(change introduced in v1.2). Commons CLI 1.4 at least requires Java 5.0.
-More information can be found on the project site at
+More information can be found on the project site at
http://commons.apache.org/cli.
+
+NEW FEATURES
+============
+
+o CLI-269: Introduce CommandLine.Builder
+o CLI-267: Add an addRequiredOption method to Options.
+ Thanks to Ricardo Ribeiro.
+
+
+BUG FIXES
+=========
+
+o CLI-265: Optional argument picking up next regular option as its argument.
+ Thanks to Martin Sandiford.
+o CLI-266: HelpFormatter.setOptionComparator(null) doesn't display the values
+ in inserted order. Thanks to Ravi Teja.
+
+
+ Release Notes for version 1.3.1
+
BUG FIXES
=========
@@ -36,21 +56,21 @@
DEPRECATIONS
============
-o org.apache.commons.cli.BasicParser
+o org.apache.commons.cli.BasicParser
replaced by org.apache.commons.cli.DefaultParser
-o org.apache.commons.cli.GnuParser
+o org.apache.commons.cli.GnuParser
replaced by org.apache.commons.cli.DefaultParser
-o org.apache.commons.cli.OptionBuilder
+o org.apache.commons.cli.OptionBuilder
replaced by org.apache.commons.cli.Option.builder()
org.apache.commons.cli.Option.builder(String)
org.apache.commons.cli.Option.Builder
-o org.apache.commons.cli.Parser
+o org.apache.commons.cli.Parser
replaced by org.apache.commons.cli.DefaultParser
-o org.apache.commons.cli.PosixParser
+o org.apache.commons.cli.PosixParser
replaced by org.apache.commons.cli.DefaultParser
@@ -65,9 +85,9 @@
Option.Builder. This replaces the now deprecated OptionBuilder.
Thanks to Duncan Jones, Brian Blount.
o CLI-160: PosixParser now supports partial long options (--ver instead of
- --version).
+ --version).
o CLI-169: HelpFormatter now supports setting the displayed separator of long
- options. Thanks to J. Lewis Muir.
+ options. Thanks to J. Lewis Muir.
o CLI-214: Added new method Options.addOption(String, String). Thanks to
Alexandru Mocanu.
@@ -82,7 +102,7 @@
in case of null input. Thanks to Beluga Behr.
o CLI-202: Default options will now work correctly with required options that
are missing.
-o CLI-203: Default options will now work correctly together with option groups.
+o CLI-203: Default options will now work correctly together with option groups.
o CLI-205: HelpFormatter.setArgName(String) now correctly sets the argument
name.
o CLI-204: Passing default values for not defined options to a parser will now
@@ -90,7 +110,7 @@
o CLI-201: Default properties provided as input to the Parser.parse() methods
are now correctly processed.
o CLI-215: CommandLine.getParsedOptionValue() now returns a String object if no
- option type has been explicitly set. Thanks to Manuel Müller.
+ option type has been explicitly set. Thanks to Manuel Müller.
o CLI-212: HelpFormatter now prints command-line options in the same order as
they have been added. Thanks to Per Cederberg.
o CLI-186: Standard help text now shows mandatory arguments also for the first
@@ -100,7 +120,7 @@
o CLI-185: 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.
-o CLI-184: Negative numerical arguments take precedence over numerical options.
+o CLI-184: Negative numerical arguments take precedence over numerical options.
o CLI-193: Fix possible StringIndexOutOfBoundsException in HelpFormatter.
Thanks to Travis McLeskey.
o CLI-183: OptionGroups no longer throw an AlreadySelectedException when reused
@@ -112,17 +132,17 @@
=======
o CLI-240: Small cleanup of Option class. Thanks to Beluga Behr.
-o CLI-230: Options.getRequiredOptions() now returns an unmodifiable list.
+o CLI-230: Options.getRequiredOptions() now returns an unmodifiable list.
o CLI-218: Clarify javadoc for CommandLine.getOptionValue() that the first
- specified argument will be returned. Thanks to Sven.
+ specified argument will be returned. Thanks to Sven.
o CLI-227: Changed unit tests to junit 4 annotation style. Thanks to
- Duncan Jones.
+ Duncan Jones.
o CLI-209: The javadoc of OptionBuilder now states that the class is not
- thread-safe. Thanks to Thomas Herre.
+ thread-safe. Thanks to Thomas Herre.
o CLI-200: Fixed typo in javadoc of class CommandLine. Thanks to
- Gerard Weatherby.
+ Gerard Weatherby.
o CLI-223: Source code now uses generic types instead of raw types where
- possible. Thanks to Gerard Weatherby.
+ possible. Thanks to Gerard Weatherby.
o CLI-220 Corrected javadoc for return type of
MissingOptionException.getMissingOptions(). Thanks to Joe Casadonte.
o CLI-197: Improve description of parameter "stopAtNonOption" in method
@@ -140,7 +160,7 @@
o -- : The method getOptionProperties() in the CommandLine class was added
to retrieve easily the key/value pairs specified with options like
-Dkey1=value1 -Dkey2=value2.
-o CLI-157: GnuParser now supports long options with an '=' sign
+o CLI-157: GnuParser now supports long options with an '=' sign
(ie. --foo=bar and -foo=bar)
o CLI-155: The ordering of options can be defined in help messages.
@@ -154,7 +174,7 @@
o CLI-163: PosixParser no longer stops the bursting process of a token if
stopAtNonOption is enabled and a non option character is
encountered.
-o CLI-165: PosixParser no longer keeps processing the tokens after an
+o CLI-165: PosixParser no longer keeps processing the tokens after an
unrecognized long option when stopAtNonOption is enabled.
o CLI-156: Required options are properly checked if an Options instance is used
twice to parse a command line.
@@ -179,31 +199,31 @@
NEW FEATURES
============
-o CLI-78: Setting description of a Option.
+o CLI-78: Setting description of a Option.
CHANGES
=======
-o CLI-2: Wrong usage summary.
-o CLI-5: Dependecy on commons-lang-2.0 but commons-lang-1.0 is obtained.
+o CLI-2: Wrong usage summary.
+o CLI-5: Dependecy on commons-lang-2.0 but commons-lang-1.0 is obtained.
o CLI-8: Line separator as first char for helpformatter (footer) throws
- exception.
-o CLI-13: CommandLine.getOptionValue() behaves contrary to docs.
-o CLI-21: clone method in Option should use super.clone().
+ exception.
+o CLI-13: CommandLine.getOptionValue() behaves contrary to docs.
+o CLI-21: clone method in Option should use super.clone().
o CLI-23: Passing properties in Parser does not work for options with a single
- argument.
-o CLI-26: Only long options without short option seems to be noticed.
-o CLI-28: Infinite Loop in Command-Line processing.
-o CLI-29: Options should not be able to be added more than once.
-o CLI-35: HelpFormatter doesn't sort options properly.
+ argument.
+o CLI-26: Only long options without short option seems to be noticed.
+o CLI-28: Infinite Loop in Command-Line processing.
+o CLI-29: Options should not be able to be added more than once.
+o CLI-35: HelpFormatter doesn't sort options properly.
o CLI-38: HelpFormatter doesn't function correctly for options with only
- LongOpt.
-o CLI-44: Document enhancement.
-o CLI-45: Documentation errors.
-o CLI-51: Parameter value "-something" misinterpreted as a parameter.
-o CLI-56: clone() method doesn't fully clone contents.
-o CLI-59: No Javadoc for HelpFormatter!.
-o CLI-65: Parser breaks up command line parms into single characters.
+ LongOpt.
+o CLI-44: Document enhancement.
+o CLI-45: Documentation errors.
+o CLI-51: Parameter value "-something" misinterpreted as a parameter.
+o CLI-56: clone() method doesn't fully clone contents.
+o CLI-59: No Javadoc for HelpFormatter!.
+o CLI-65: Parser breaks up command line parms into single characters.
o CLI-67: Missing arguments in HelpFormatter.renderOptions(..).
o CLI-69: Error parsing option arguments.
o CLI-71: A weakness of parser.
@@ -212,17 +232,17 @@
o CLI-131: Options class returns options in random order.
o CLI-132: MissingOptionException should contain a useful error message.
o CLI-133: NullPointerException in Util.stripLeadingHyphens when passed a null
- argument.
+ argument.
o CLI-134: 1.1 is not backwards compatible because it adds methods to the
- CommandLineParser interface.
+ CommandLineParser interface.
o CLI-135: Backwards compatibility between 1.1 and 1.0 broken due to
- Option.addValue removal.
+ Option.addValue removal.
Historical list of changes: http://commons.apache.org/cli/changes-report.html
For complete information on Commons CLI, including instructions on how to
-submit bug reports, patches, or suggestions for improvement, see the
+submit bug reports, patches, or suggestions for improvement, see the
Apache Commons CLI website:
http://commons.apache.org/cli/
diff --git a/pom.xml b/pom.xml
index 0355b90..49cf154 100644
--- a/pom.xml
+++ b/pom.xml
@@ -166,7 +166,7 @@
<maven.compiler.source>1.5</maven.compiler.source>
<maven.compiler.target>1.5</maven.compiler.target>
<commons.componentid>cli</commons.componentid>
- <commons.release.version>1.3.1</commons.release.version>
+ <commons.release.version>1.4</commons.release.version>
<commons.release.name>commons-cli-${commons.release.version}</commons.release.name>
<commons.osgi.symbolicName>org.apache.commons.cli</commons.osgi.symbolicName>
<commons.jira.id>CLI</commons.jira.id>
diff --git a/src/site/xdoc/download_cli.xml b/src/site/xdoc/download_cli.xml
index 21ceb75..249ed69 100644
--- a/src/site/xdoc/download_cli.xml
+++ b/src/site/xdoc/download_cli.xml
@@ -95,32 +95,32 @@
</p>
</subsection>
</section>
- <section name="Apache Commons CLI 1.3.1 ">
+ <section name="Apache Commons CLI 1.4 ">
<subsection name="Binaries">
<table>
<tr>
- <td><a href="[preferred]/commons/cli/binaries/commons-cli-1.3.1-bin.tar.gz">commons-cli-1.3.1-bin.tar.gz</a></td>
- <td><a href="http://www.apache.org/dist/commons/cli/binaries/commons-cli-1.3.1-bin.tar.gz.md5">md5</a></td>
- <td><a href="http://www.apache.org/dist/commons/cli/binaries/commons-cli-1.3.1-bin.tar.gz.asc">pgp</a></td>
+ <td><a href="[preferred]/commons/cli/binaries/commons-cli-1.4-bin.tar.gz">commons-cli-1.4-bin.tar.gz</a></td>
+ <td><a href="http://www.apache.org/dist/commons/cli/binaries/commons-cli-1.4-bin.tar.gz.md5">md5</a></td>
+ <td><a href="http://www.apache.org/dist/commons/cli/binaries/commons-cli-1.4-bin.tar.gz.asc">pgp</a></td>
</tr>
<tr>
- <td><a href="[preferred]/commons/cli/binaries/commons-cli-1.3.1-bin.zip">commons-cli-1.3.1-bin.zip</a></td>
- <td><a href="http://www.apache.org/dist/commons/cli/binaries/commons-cli-1.3.1-bin.zip.md5">md5</a></td>
- <td><a href="http://www.apache.org/dist/commons/cli/binaries/commons-cli-1.3.1-bin.zip.asc">pgp</a></td>
+ <td><a href="[preferred]/commons/cli/binaries/commons-cli-1.4-bin.zip">commons-cli-1.4-bin.zip</a></td>
+ <td><a href="http://www.apache.org/dist/commons/cli/binaries/commons-cli-1.4-bin.zip.md5">md5</a></td>
+ <td><a href="http://www.apache.org/dist/commons/cli/binaries/commons-cli-1.4-bin.zip.asc">pgp</a></td>
</tr>
</table>
</subsection>
<subsection name="Source">
<table>
<tr>
- <td><a href="[preferred]/commons/cli/source/commons-cli-1.3.1-src.tar.gz">commons-cli-1.3.1-src.tar.gz</a></td>
- <td><a href="http://www.apache.org/dist/commons/cli/source/commons-cli-1.3.1-src.tar.gz.md5">md5</a></td>
- <td><a href="http://www.apache.org/dist/commons/cli/source/commons-cli-1.3.1-src.tar.gz.asc">pgp</a></td>
+ <td><a href="[preferred]/commons/cli/source/commons-cli-1.4-src.tar.gz">commons-cli-1.4-src.tar.gz</a></td>
+ <td><a href="http://www.apache.org/dist/commons/cli/source/commons-cli-1.4-src.tar.gz.md5">md5</a></td>
+ <td><a href="http://www.apache.org/dist/commons/cli/source/commons-cli-1.4-src.tar.gz.asc">pgp</a></td>
</tr>
<tr>
- <td><a href="[preferred]/commons/cli/source/commons-cli-1.3.1-src.zip">commons-cli-1.3.1-src.zip</a></td>
- <td><a href="http://www.apache.org/dist/commons/cli/source/commons-cli-1.3.1-src.zip.md5">md5</a></td>
- <td><a href="http://www.apache.org/dist/commons/cli/source/commons-cli-1.3.1-src.zip.asc">pgp</a></td>
+ <td><a href="[preferred]/commons/cli/source/commons-cli-1.4-src.zip">commons-cli-1.4-src.zip</a></td>
+ <td><a href="http://www.apache.org/dist/commons/cli/source/commons-cli-1.4-src.zip.md5">md5</a></td>
+ <td><a href="http://www.apache.org/dist/commons/cli/source/commons-cli-1.4-src.zip.asc">pgp</a></td>
</tr>
</table>
</subsection>
