1------------------------------ 2shFlags.sh 1.0.1 Release Notes 3------------------------------ 4 5Preface 6------- 7Copyright 2008 Kate Ward. All Rights Reserved. 8Released under the LGPL (GNU Lesser General Public License) 9 10Author: Kate Ward (kate.ward@forestent.com) 11 12This document covers any known issues and workarounds for the stated release of 13shFlags. 14 15General info 16------------ 17 18This is both a minor bug fix release, and a minor new feature release of 19shFlags. It adds several warning messages, fixes three issues, and now displays 20the default value behind the help string when help is requested. Additionally, 21the coding standards have been modified slightly and officially documented. 22They were taken from the standards used by shUnit2 (the unit testing framework 23used for the unit testing). 24 25Please see the CHANGES-1.0.txt file for a complete list of changes. 26 27The unit tests 28-------------- 29 30shFlags is designed to work on as many environments as possible, but not all 31environments are created equal. As such, not all of the unit tests will succeed 32on every platform. The unit tests are therefore designed to fail, indicating to 33the tester that the supported functionality is not present, but an additional 34test is present to verify that shFlags properly caught the limitation and 35presented the user with an appropriate error message. 36 37shFlags tries to support both the standard and enhanced versions of **getopt**. 38As each responds differently, and not everything is supported on the standard 39version, some unit tests will be skipped (i.e. ASSERTS will not be thrown) when 40the standard version of **getopt** is detected. The reason being that there is 41no point testing for functionality that is positively known not to exist. A 42tally of skipped tests will be kept for later reference. 43 44To see the test results for the various OSes tested, please visit 45http://forestent.com/projects/shflags/testresults/. 46 47Standard vs Enhanced getopt 48--------------------------- 49 50Here is a matrix of the supported features of the various **getopt** variants. 51 52+-------------------------+---+---+ 53|Feature |std|enh| 54+=========================+===+===+ 55|short option names | Y | Y | 56|long option names | N | Y | 57|spaces in string options | N | Y | 58+-------------------------+---+---+ 59 60Known Issues 61------------ 62 63The **getopt** version provided by default with all versions of Mac OS X (up to 64and including 10.5.5) is the standard version. As such, only short flags are 65supported. 66 67The **getopt** version provided by default with all versions of Solaris (up to 68and including Solaris 10 and OpenSolaris) is the standard version. As such, 69only short flags are supported. 70 71Workarounds 72----------- 73 74The Zsh shell requires the ``shwordsplit`` option to be set, and the special 75``FLAGS_PARENT`` variable must be defined. 76 77 78.. vim:fileencoding=latin1:ft=rst:spell:tw=80 79