diff options
author | Kate Ward <kate.ward@forestent.com> | 2017-10-18 21:15:01 +0200 |
---|---|---|
committer | Kate Ward <kate.ward@forestent.com> | 2017-10-18 21:15:01 +0200 |
commit | 2907ef29b6f76ca7caba08d459ccc8f1ed597b28 (patch) | |
tree | 720ab1a23d9d7c3513da4b06f67ecfaa56aa2892 | |
parent | 271a12cb0c7cb62f409c613365364aa6d3a850d8 (diff) | |
download | shflags-2907ef29b6f76ca7caba08d459ccc8f1ed597b28.tar.gz |
Updated CHANGES and RELEASE_NOTES in preparation for 1.2.2 release.
-rw-r--r-- | doc/CHANGES-1.2.md | 8 | ||||
-rw-r--r-- | doc/RELEASE_NOTES-1.2.0.md | 2 | ||||
-rw-r--r-- | doc/RELEASE_NOTES-1.2.1.md | 66 | ||||
-rw-r--r-- | doc/RELEASE_NOTES-1.2.2.md | 74 |
4 files changed, 147 insertions, 3 deletions
diff --git a/doc/CHANGES-1.2.md b/doc/CHANGES-1.2.md index 0f76a94..8f61e5c 100644 --- a/doc/CHANGES-1.2.md +++ b/doc/CHANGES-1.2.md @@ -4,16 +4,20 @@ Ran all scripts through [ShellCheck](http://www.shellcheck.net/). -Replaced shflags_test.sh with test_runner from https://github.com/kward/shlib. +Replaced `shflags_test.sh` with `test_runner` from +https://github.com/kward/shlib. Fixed issue #45. Empty help string causes `shflags_test_issue_28.sh` to fail. +Continuous integration testing setup with +[Travis CI](https://travis-ci.org/kward/shflags). + Restructured code to be more GitHub like. ## Changes with 1.2.1 -Fixed issue #43. Added support for BusyBox ash shell. +Fixed issue #43. Added support for BusyBox `ash` shell. Fixed issues #26, #27. Re-factored `_flags_itemInList()` to use built-ins. diff --git a/doc/RELEASE_NOTES-1.2.0.md b/doc/RELEASE_NOTES-1.2.0.md index bf76941..09cb69d 100644 --- a/doc/RELEASE_NOTES-1.2.0.md +++ b/doc/RELEASE_NOTES-1.2.0.md @@ -12,7 +12,7 @@ Release info This is a minor bug fix release. -Please see the `CHANGES-1.0.txt` file for a complete list of changes. +Please see the `CHANGES-1.2.md` file for a complete list of changes. Major changes ------------- diff --git a/doc/RELEASE_NOTES-1.2.1.md b/doc/RELEASE_NOTES-1.2.1.md new file mode 100644 index 0000000..789768e --- /dev/null +++ b/doc/RELEASE_NOTES-1.2.1.md @@ -0,0 +1,66 @@ +# shFlags 1.2.1 Release Notes + +https://github.com/kward/shflags + +## Preface + +This document covers any known issues and workarounds for the stated release of +shFlags. + + +## Release info + +This is a minor bug fix release. + +Please see the `CHANGES-1.2.md` file for a complete list of changes. + +### Notable changes + +Support for the BusyBox `ash` shell was added. + +### Notable bug fixes + +Fixed issue #28. DEFINE_boolean misbehaves when help-string is empty. + + +## General info + +### The unit tests + +shFlags is designed to work on as many environments as possible, but not all +environments are created equal. As such, not all of the unit tests will succeed +on every platform. The unit tests are therefore designed to fail, indicating to +the tester that the supported functionality is not present, but an additional +test is present to verify that shFlags properly caught the limitation and +presented the user with an appropriate error message. + +shFlags tries to support both the standard and enhanced versions of `getopt`. +As each responds differently, and not everything is supported on the standard +version, some unit tests will be skipped (i.e. ASSERTS will not be thrown) when +the standard version of `getopt` is detected. The reason being that there is +no point testing for functionality that is positively known not to exist. A +tally of skipped tests will be kept for later reference. + +### Standard vs Enhanced getopt + +Here is a matrix of the supported features of the various `getopt` variants. + +| Feature | std | enh | +|-----------------------------------------|-----|-----| +| short option names | Y | Y | +| long option names | N | Y | +| spaces in string options | N | Y | +| intermixing of flag and non-flag values | N | Y | + + +## Known Issues + +The `getopt` version provided by default with all versions of Mac OS X (up to +and including 10.10.2) and Solaris (up to and including Solaris 10 and +OpenSolaris) is the standard version. + +## Workarounds + +The Zsh shell requires the `shwordsplit` option to be set and the special +`FLAGS_PARENT` variable must be defined. See `src/shflags_test_helpers` to +see how the unit tests do this. diff --git a/doc/RELEASE_NOTES-1.2.2.md b/doc/RELEASE_NOTES-1.2.2.md new file mode 100644 index 0000000..c919314 --- /dev/null +++ b/doc/RELEASE_NOTES-1.2.2.md @@ -0,0 +1,74 @@ +# shFlags 1.2.2 Release Notes + +https://github.com/kward/shflags + +## Preface + +This document covers any known issues and workarounds for the stated release of +shFlags. + + +## Release info + +This is a minor bug fix release. + +Please see the `CHANGES-1.2.md` file for a complete list of changes. + +### Notable changes + +Continuous integration testing setup with +[Travis CI](https://travis-ci.org/kward/shflags). This helps keep the code in +a working state by executing the unit tests on every submit. + +All code run through [ShellCheck](http://www.shellcheck.net/). This is an +excellent shell linter, and brings consistency to the coding patterns used. + +The code was restructured to be more GitHub friendly. It should make the code +more appealing to a wider audience. + +### Notable bug fixes + +Fixed issue #45. Empty help string causes `shflags_test_issue_28.sh` to fail. + + +## General info + +### The unit tests + +shFlags is designed to work on as many environments as possible, but not all +environments are created equal. As such, not all of the unit tests will succeed +on every platform. The unit tests are therefore designed to fail, indicating to +the tester that the supported functionality is not present, but an additional +test is present to verify that shFlags properly caught the limitation and +presented the user with an appropriate error message. + +shFlags tries to support both the standard and enhanced versions of `getopt`. +As each responds differently, and not everything is supported on the standard +version, some unit tests will be skipped (i.e. ASSERTS will not be thrown) when +the standard version of `getopt` is detected. The reason being that there is +no point testing for functionality that is positively known not to exist. A +tally of skipped tests will be kept for later reference. + +### Standard vs Enhanced getopt + +Here is a matrix of the supported features of the various `getopt` variants. + +| Feature | std | enh | +|-----------------------------------------|-----|-----| +| short option names | Y | Y | +| long option names | N | Y | +| spaces in string options | N | Y | +| intermixing of flag and non-flag values | N | Y | + + +## Known Issues + +The `getopt` version provided by default with all versions of Mac OS X (up to +and including 10.13.0) and Solaris (up to and including Solaris 10 and +OpenSolaris) is the standard version. + +## Workarounds + +The Zsh shell requires the `shwordsplit` option to be set and the special +`FLAGS_PARENT` variable must be defined. See `src/shflags_test_helpers` to +see how the unit tests do this. |