Skip to content
Browse files

finalizing 1.0.2 release

git-svn-id: http://shflags.googlecode.com/svn/trunk/source/1.0@107 9d7cb843-df4f-0410-8a79-4785ae5a3405
  • Loading branch information...
1 parent 78a5ca2 commit 88314b3f8e196251a0c21d5735e035cd56bd82a0 kate.ward@forestent.com committed Nov 17, 2008
Showing with 84 additions and 28 deletions.
  1. +0 −11 README.html
  2. +0 −11 README.txt
  3. +5 −5 doc/CHANGES-1.0.txt
  4. +78 −0 doc/RELEASE_NOTES-1.0.2.txt
  5. +1 −1 src/shflags
View
11 README.html
@@ -344,17 +344,6 @@ <h1 class="title">shFlags 1.0.x README</h1>
<h2>Write Release Notes</h2>
<p>This should be pretty self explainatory. Use one of the release notes from a
previous release as an example.</p>
-<p>To get the versions of the various shells, run the <cite>bin/version_info.sh</cite>
-command.</p>
-<pre class="literal-block">
-$ bin/shell_versions.sh
-os:Mac OS X version:10.5.3
-shell:/bin/bash version:3.2.17(1)-release
-shell:/bin/dash version:not_installed
-shell:/bin/ksh version:M-1993-12-28
-shell:/bin/pdksh version:not_installed
-shell:/bin/zsh version:4.3.4
-</pre>
</div>
<div class="section" id="update-version">
<h2>Update Version</h2>
View
11 README.txt
@@ -47,17 +47,6 @@ Write Release Notes
This should be pretty self explainatory. Use one of the release notes from a
previous release as an example.
-To get the versions of the various shells, run the `bin/version_info.sh`
-command. ::
-
- $ bin/shell_versions.sh
- os:Mac OS X version:10.5.3
- shell:/bin/bash version:3.2.17(1)-release
- shell:/bin/dash version:not_installed
- shell:/bin/ksh version:M-1993-12-28
- shell:/bin/pdksh version:not_installed
- shell:/bin/zsh version:4.3.4
-
Update Version
--------------
View
10 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$
View
78 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
View
2 src/shflags
@@ -72,7 +72,7 @@
# return if FLAGS already loaded
[ -n "${FLAGS_VERSION:-}" ] && return 0
-FLAGS_VERSION='1.0.2pre'
+FLAGS_VERSION='1.0.2'
FLAGS_TRUE=0
FLAGS_FALSE=1

0 comments on commit 88314b3

Please sign in to comment.
Something went wrong with that request. Please try again.