diff options
Diffstat (limited to 'doc/RELEASE_NOTES-1.2.3.md')
-rw-r--r-- | doc/RELEASE_NOTES-1.2.3.md | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/doc/RELEASE_NOTES-1.2.3.md b/doc/RELEASE_NOTES-1.2.3.md new file mode 100644 index 0000000..2764721 --- /dev/null +++ b/doc/RELEASE_NOTES-1.2.3.md @@ -0,0 +1,67 @@ +# shFlags 1.2.3 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 and cleanup release. + +There were several minor changes thanks to feedback from a major code review by +[James Youngman](https://www.linkedin.com/in/jamesyoungman/). Thank you! + +Please see the `CHANGES-1.2.md` file for a complete list of changes. + +### Notable changes + +None. + +### Notable bug fixes + +Fixed the examples to work again with the new code structure. These broke when +the code was refactored for GitHub. + +## 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. |