| 1 | $Id: RELEASE-NOTES.txt 695235 2008-09-14 15:26:10Z ebourg $ |
|---|
| 2 | |
|---|
| 3 | Commons CLI Package |
|---|
| 4 | Version 1.2 |
|---|
| 5 | Release Notes |
|---|
| 6 | |
|---|
| 7 | |
|---|
| 8 | INTRODUCTION: |
|---|
| 9 | |
|---|
| 10 | This document contains the release notes for this version of the Commons CLI |
|---|
| 11 | package. Commons CLI provides a simple API for working with the command line |
|---|
| 12 | arguments and options. |
|---|
| 13 | |
|---|
| 14 | Commons CLI 1.2 is a bugfix release. The following notable changes were made: |
|---|
| 15 | |
|---|
| 16 | * A major regression introduced in CLI 1.1 that prevented the usage of repeated options has been fixed. |
|---|
| 17 | * Several parser issues have been fixed, especially with the PosixParser. |
|---|
| 18 | * HelpFormatter now wraps the lines properly |
|---|
| 19 | * The ordering of the option in the help message can now be defined. |
|---|
| 20 | * Various API enhancements (improved exceptions, serializable classes) |
|---|
| 21 | |
|---|
| 22 | Commons CLI 1.2 is binary compatible with the previous versions, except for |
|---|
| 23 | the OptionValidator class that is no longer public. |
|---|
| 24 | |
|---|
| 25 | More information can be found on the project site at http://commons.apache.org/cli |
|---|
| 26 | |
|---|
| 27 | |
|---|
| 28 | NEW FEATURES: |
|---|
| 29 | |
|---|
| 30 | * The method getOptionProperties() in the CommandLine class was added |
|---|
| 31 | to retrieve easily the key/value pairs specified with options like |
|---|
| 32 | -Dkey1=value1 -Dkey2=value2. |
|---|
| 33 | |
|---|
| 34 | * GnuParser now supports long options with an '=' sign |
|---|
| 35 | (ie. --foo=bar and -foo=bar) (CLI-157) |
|---|
| 36 | |
|---|
| 37 | * The ordering of options can be defined in help messages. (CLI-155) |
|---|
| 38 | |
|---|
| 39 | |
|---|
| 40 | BUG FIXES: |
|---|
| 41 | |
|---|
| 42 | * The number of arguments defined for an option specifies the arguments |
|---|
| 43 | per occurrence of the option and not for all occurrences. (CLI-137) |
|---|
| 44 | |
|---|
| 45 | * PosixParser no longer ignores unrecognized short options. (CLI-164) |
|---|
| 46 | |
|---|
| 47 | * PosixParser no longer stops the bursting process of a token if stopAtNonOption |
|---|
| 48 | is enabled and a non option character is encountered. (CLI-163) |
|---|
| 49 | |
|---|
| 50 | * PosixParser no longer keeps processing the tokens after an unrecognized |
|---|
| 51 | long option when stopAtNonOption is enabled. (CLI-165) |
|---|
| 52 | |
|---|
| 53 | * Required options are properly checked if an Options instance is used twice |
|---|
| 54 | to parse a command line. (CLI-156) |
|---|
| 55 | |
|---|
| 56 | * The line wrapping in HelpFormatter now works properly. (CLI-151) |
|---|
| 57 | |
|---|
| 58 | |
|---|
| 59 | CHANGES: |
|---|
| 60 | |
|---|
| 61 | * The message of MissingOptionException has been improved. (CLI-149) |
|---|
| 62 | |
|---|
| 63 | * The exceptions have been enhanced with methods to retrieve easily |
|---|
| 64 | the related options. (CLI-86) |
|---|
| 65 | |
|---|
| 66 | * Option.toString() now reports arguments properly. (CLI-141) |
|---|
| 67 | |
|---|
| 68 | * The Parser class has been changed to be more easily extendable. (CLI-142) |
|---|
| 69 | |
|---|
| 70 | * The following classes are now serializable: Option, OptionGroup, |
|---|
| 71 | CommandLine and Options. (CLI-140) |
|---|
| 72 | |
|---|
| 73 | * OptionValidator is no longer public, its methods were all private. |
|---|
