1 ------------------------------ 2 shFlags.sh 1.0.0 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 the first official release of shFlags. The project is modeled after the 19 gflags code released by Google on http://code.google.com/p/google-gflags/. Many 20 thanks for the code they have provided. 21 22 As this is the first release, there are bound to be issues. Feel free 23 24 Disclamer 25 --------- 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 Standard vs Enhanced getopt 45 --------------------------- 46 47 Here is a matrix of the supported features of the various getopt variants. 48 49 +-------------------------+---+---+ 50 |Feature |std|enh| 51 +=========================+===+===+ 52 |short option names | Y | Y | 53 |long option names | N | Y | 54 |spaces in string options | N | Y | 55 +-------------------------+---+---+ 56 57 Known Issues 58 ------------ 59 60 The getopt version provided by default with all versions of Solaris (up to and 61 including Solaris 10) is the standard version. As such, only short flags are 62 supported. 63 64 The getopt version provided by default with all versions of Mac OS X (up to and 65 including 10.5) is the standard version. As such, only short flags are 66 supported. 67 68 Workarounds 69 ----------- 70 71 The zsh shell requires the 'shwordsplit' option to be set, and the special 72 FLAGS_PARENT variable must be defined. 73
