1# Changes in shFlags 2 3## 1.3.x development series 4 5### Changes with 1.3.0 6 7*A new series was started due to the major changes required for 'set -e' support.* 8 9Upgraded shUnit2 to 2.1.9pre, which includes 'set -e' support. 10 11Fixed #9. shFlags now works properly with 'set -e' enabled. 12 13Fixed #50. The `FLAGS_ARGC` variable is no longer is no longer exported. The variable was marked obsolete in 1.0.3, and it is finally being removed. 14 15--- 16 17## 1.2.x stable series 18 19### Changes with 1.2.3 20 21Upgraded shUnit2 to 2.1.7. 22 23Fixed the examples to work again with the new code structure. 24 25Removed `gen_test_report.sh` as it isn't used anymore. 26 27Minor fix for `_flags_underscoreName()` to insure POSIX compliance. 28 29Cleanup of pre-GitHub cruft. 30 31Fixed bug in `_flags_columns()` where `stty size` sometimes gave unexpected 32output, causing the function to not work. 33 34Replaced `test_runner` with upstream from https://github.com/kward/shlib. 35 36### Changes with 1.2.2 37 38Ran all scripts through [ShellCheck](http://www.shellcheck.net/). 39 40Replaced `shflags_test.sh` with `test_runner` from https://github.com/kward/shlib. 41 42Fixed issue #45. Empty help string causes `shflags_test_issue_28.sh` to fail. 43 44Continuous integration testing setup with [Travis CI](https://travis-ci.org/kward/shflags). 45 46Restructured code to be more GitHub like. 47 48### Changes with 1.2.1 49 50Fixed issue #43. Added support for BusyBox `ash` shell. 51 52Fixed issues #26, #27. Re-factored `_flags_itemInList()` to use built-ins. 53 54Fixed issue #31. Documented newline support in `FLAGS_HELP`. 55 56Fixed issue #28. `DEFINE_boolean` misbehaves when help-string is empty. 57 58Fixed issue #25. Fix some typos. 59 60### Changes with 1.2.0 61 62Changed from the LGPL v2.1 license to the Apache v2.0 license so that others can include the library or make changes without needing to release the modified source code as well. 63 64Moved documentation to Markdown. 65 66Migrated the code to GitHub as http://code.google.com/ is turning down. 67 68Fixed issue #10. Usage of `expr` under FreeBSD 7.2 (FreeNAS 0.7.1) and FreeBSD 8.0 that was causing many unit tests to fail. 69 70Fixed issue where booleans were sometimes mis-configured to require additional values like other flags. 71 72Changed `_flags_fatal()` to exit with `FLAGS_ERROR` immediately. 73 74Fixed issue #11. When help is requested, the help flag is no longer prefixed with '[no]'. 75 76Upgraded shUnit2 to 2.1.6. 77 78Fixed issue #12. Requesting help shouldn't be considered an error. 79 80Added the ability to override the use of the OS default `getopt` command by defining the `FLAGS_GETOPT_CMD` variable. 81 82Updated `gen_test_results.sh` and versions from shUnit2 source. 83 84Fixed issues #13, #14. Added support for dashes '-' in long flag names. The defined flag will still be declared with underscores '\_' due to shell limitations, so only one of a dashed flag name or an underscored flag name are allowed, not both. (Backslash on _ to prevent Markdown formatting.) 85 86Issue #20. Updated LGPL v2.1 license from http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt. 87 88Issue #15. Use `gexpr` instead of `expr` on BSD variants. 89 90Minor tweaks to make run on FreeBSD 9.1. 91 92Fixed issue in `shflags_test_public.sh` where screens >80 columns were causing a test to fail. 93 94Issue #22. Fixed broken `testGetFlagInfo()` test. 95 96Created alternate `validFloat()` and `validInt()` functions that use shell built-ins where possible to increase performance and reduce the usage of the `expr` command. 97 98Added separate built-in and `expr` functions for doing math. 99 100--- 101 102## 1.0.x stable series 103 104### Changes with 1.0.3 105 106MAJOR CHANGE! `FLAGS_ARGC` is now obsolete, and is replaced by `FLAGS_ARGV`. See below for more info. 107 108Fixed issue# 7 where long flags defined with '=' (e.g. `--abc=123`) made it impossible for the user to know how many non-flag command-line arguments were available because the value returned by `FLAGS_ARGC` was wrong. The `FLAGS_ARGC` value is now obsolete, but will be maintained for backwards compatibility. The new method of getting the non-flag arguments is by executing `eval set -- "${FLAGS_ARGV}"` after the `FLAGS` call. The arguments will then be available using the standard shell $#, $@, $\*, $1, etc. variables. (Backslash on \* to prevent Markdown formatting.) 109 110Due to above fix for issue# 7, there is now proper support for mixing flags with non-flag arguments on the command-line. Previously, all non-flag arguments had to be at the end of the command-line. 111 112Renamed `_flags_standardGetopt()` and `_flags_enhancedGetopt()` functions to `_flags_getoptStandard()` and `_flags_getoptEnhanced()`. 113 114Took out the setting and restoration of the '-u' shell flag to treat unset variables as an error. No point in having it in this library as it is verified in the unit tests, and provides basically no benefit. 115 116Fixed bug under Solaris where the generated help was adding extra 'x' characters. 117 118Added checks for reserved flag variables (e.g. `FLAGS_TRUE`). 119 120Fixed some unset variable bugs. 121 122Now report the actual `getopt` error if there is one. 123 124All tests now properly enable skipping based on whether a standard or enhanced `getopt` is found. 125 126Added the OS version to OS release for Solaris. 127 128Fixed `flags_reset()` so it unsets the default value environment vars. 129 130### Changes with 1.0.2 131 132`${FLAGS_PARENT}` no longer transforms into a constant so that it can be defined at run time in scripts. 133 134Added warning about short flags being unsupported when there are problems 135parsing the options with `getopt`. 136 137Add default values to end of description strings. 138 139Fixed bug that returned an error instead of success when recalling the default values for empty strings. 140 141Added warning when a duplicate flag definition is attempted. 142 143Improved `assert[Warn|Error]Msg()` test helper grepping. 144 145Replaced shell_versions.sh with a new versions library and created `gen_test_results.sh` to make releases easier. 146 147Copied the coding standards from shUnit2, but haven't fully implemented them in shFlags yet. 148 149Issue# 1: When a user defines their own `--help` flag, no more warning is thrown when `FLAGS()` is called stating that the help flag already defined. 150 151Issue# 2: Passing the `--nohelp` option no longer gives help output. 152 153Issue# 3: Added support for screen width detection. 154 155### Changes with 1.0.1 156 157Fixed bug where the help output added '[no]' to all flag names 158 159Added additional example files that are referenced by the documentation. 160 161Improved `zsh` version and option checking. 162 163Upgraded shUnit2 to 2.1.4 164 165Added unit testing for the help output. 166 167When including a library (e.g. shflags) in a script, zsh 3.0.8 doesn't actually execute the code in-line, but later. As such, variables that are defined in the library cannot be used until functions are called from the main code. This required the 'help' flag definition to be moved inside the `FLAGS` command. 168 169### Changes with 1.0.0 170 171This is the first official release, so everything is new. 172