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