aboutsummaryrefslogtreecommitdiff
path: root/source/1.0/doc
diff options
context:
space:
mode:
authorkate.ward <kate.ward@forestent.com>2008-06-18 20:51:29 +0000
committerkate.ward <kate.ward@forestent.com>2008-06-18 20:51:29 +0000
commit90fd99d88a52c70a34ff4a8e00ed8a18ef0b6992 (patch)
treef4e62615455be05afa2fb0157473ef4d78e43359 /source/1.0/doc
parentf8ea86327c5b62d80528e1e6930605b149bb9c7e (diff)
downloadshflags-90fd99d88a52c70a34ff4a8e00ed8a18ef0b6992.tar.gz
finalizing 1.0.0 release
Diffstat (limited to 'source/1.0/doc')
-rw-r--r--source/1.0/doc/CHANGES-1.0.txt7
-rw-r--r--source/1.0/doc/RELEASE_NOTES-1.0.0.txt18
2 files changed, 16 insertions, 9 deletions
diff --git a/source/1.0/doc/CHANGES-1.0.txt b/source/1.0/doc/CHANGES-1.0.txt
new file mode 100644
index 0000000..8321228
--- /dev/null
+++ b/source/1.0/doc/CHANGES-1.0.txt
@@ -0,0 +1,7 @@
+Changes in shFlags 1.0.x
+========================
+
+Changes with 1.0.0
+------------------
+
+This is the first official release, so everything is new.
diff --git a/source/1.0/doc/RELEASE_NOTES-1.0.0.txt b/source/1.0/doc/RELEASE_NOTES-1.0.0.txt
index cd55d80..e489cf5 100644
--- a/source/1.0/doc/RELEASE_NOTES-1.0.0.txt
+++ b/source/1.0/doc/RELEASE_NOTES-1.0.0.txt
@@ -16,8 +16,8 @@ General info
------------
This is the first official release of shFlags. The project is modeled after the
-gflags code released by Google on http://code.google.com/. Many thanks for the
-code they have provided.
+gflags code released by Google on http://code.google.com/p/google-gflags/. Many
+thanks for the code they have provided.
As this is the first release, there are bound to be issues. Feel free
@@ -27,19 +27,19 @@ Disclamer
The unit tests
--------------
-gflags is designed to work on as many environments as possible, but not all
+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 gflags properly caught the limitation and
+test is present to verify that shFlags properly caught the limitation and
presented the user with an appropriate error message.
-gflags tries to support both the standard and enhanced versions of getopt. As
-each responds differently, and not everything is supported on the standard
+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.
+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.
Standard vs Enhanced getopt
---------------------------