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