diff options
author | kate.ward <kate.ward@forestent.com> | 2008-11-17 17:56:43 +0000 |
---|---|---|
committer | kate.ward <kate.ward@forestent.com> | 2008-11-17 17:56:43 +0000 |
commit | 1469dda33398b0926a3ca752fb8b7f669c152dbb (patch) | |
tree | bac62320ba10fdb2e9deda6ea0ac57fafa32f87a /source/1.0/doc | |
parent | de77c878f1cc3f75bd59171d50a76c028a8d43f8 (diff) | |
download | shflags-1469dda33398b0926a3ca752fb8b7f669c152dbb.tar.gz |
finalizing 1.0.2 release
Diffstat (limited to 'source/1.0/doc')
-rw-r--r-- | source/1.0/doc/CHANGES-1.0.txt | 10 | ||||
-rw-r--r-- | source/1.0/doc/RELEASE_NOTES-1.0.2.txt | 78 |
2 files changed, 83 insertions, 5 deletions
diff --git a/source/1.0/doc/CHANGES-1.0.txt b/source/1.0/doc/CHANGES-1.0.txt index b6a07f6..1eac214 100644 --- a/source/1.0/doc/CHANGES-1.0.txt +++ b/source/1.0/doc/CHANGES-1.0.txt @@ -8,7 +8,7 @@ FLAGS_PARENT no longer transforms into a constant so that it can be defined at run time in scripts. Added warning about short flags being unsupported when there are problems -parsing the options with getopt. +parsing the options with **getopt**. Add default values to end of description strings. @@ -17,10 +17,10 @@ values for empty strings. Added warning when a duplicate flag definition is attempted. -Improved assert[Warn|Error]Msg() test helper grepping. +Improved ``assert[Warn|Error]Msg()`` test helper grepping. Replaced shell_versions.sh with a new versions library and created -gen_test_results.sh to make releases easier. +**gen_test_results.sh** to make releases easier. Copied the coding standards from shUnit2, but haven't fully implemented them in shFlags yet. @@ -30,7 +30,7 @@ when FLAGS() is called stating that the help flag already defined. Issue# 2: Passing the --nohelp option no longer gives help output. -Issue# 3: Added initial support for screen width detection. +Issue# 3: Added support for screen width detection. Changes with 1.0.1 @@ -58,5 +58,5 @@ Changes with 1.0.0 This is the first official release, so everything is new. -.. vim:spell +.. vim:fileencoding=latin1:ft=rst:spell:tw=80 .. $Id$ diff --git a/source/1.0/doc/RELEASE_NOTES-1.0.2.txt b/source/1.0/doc/RELEASE_NOTES-1.0.2.txt new file mode 100644 index 0000000..f8154c7 --- /dev/null +++ b/source/1.0/doc/RELEASE_NOTES-1.0.2.txt @@ -0,0 +1,78 @@ +------------------------------ +shFlags.sh 1.0.1 Release Notes +------------------------------ + +Preface +------- +Copyright 2008 Kate Ward. All Rights Reserved. +Released under the LGPL (GNU Lesser General Public License) + +Author: Kate Ward (kate.ward@forestent.com) + +This document covers any known issues and workarounds for the stated release of +shFlags. + +General info +------------ + +This is both a minor bug fix release, and a minor new feature release of +shFlags. It adds several warning messages, fixes three issues, and now displays +the default value behind the help string when help is requested. Additionally, +the coding standards have been modified slightly and officially documented. +They were taken from the standards used by shUnit2 (the unit testing framework +used for the unit testing). + +Please see the CHANGES-1.0.txt file for a complete list of changes. + +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. + +To see the test results for the various OSes tested, please visit +http://forestent.com/projects/shflags/testresults/. + +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 | ++-------------------------+---+---+ + +Known Issues +------------ + +The **getopt** version provided by default with all versions of Mac OS X (up to +and including 10.5.5) is the standard version. As such, only short flags are +supported. + +The **getopt** version provided by default with all versions of Solaris (up to +and including Solaris 10 and OpenSolaris) is the standard version. As such, +only short flags are supported. + +Workarounds +----------- + +The Zsh shell requires the ``shwordsplit`` option to be set, and the special +``FLAGS_PARENT`` variable must be defined. + + +.. vim:fileencoding=latin1:ft=rst:spell:tw=80 |