]> pd.if.org Git - pdclib.old/blobdiff - Readme.rst
Add optional EIO to tss_errno
[pdclib.old] / Readme.rst
index c0f0767c715fd5a70a2a4a3e43597405d53f95db..fce23ea414e1b76404c6789ffee7b76ce0ffa3c4 100644 (file)
@@ -1,8 +1,9 @@
+==============================================================\r
 PDCLib - the `Public Domain C Library <http://pdclib.e43.eu>`_\r
-================================\r
+==============================================================\r
 \r
 What is it\r
-----------\r
+==========\r
 \r
 This is a C Standard Library - what's defined in ISO/IEC 9899 "Information \r
 technology — Programming languages — C" or extensions to the above defined in\r
@@ -10,7 +11,7 @@ ISO/IEC 14882 "Information technology — Programming languages — C++". A few
 extensions may optionally be provided.\r
 \r
 License\r
--------\r
+=======\r
 \r
 Written in \r
  * 2003-2012 by Martin "Solar" Baute,\r
@@ -23,18 +24,33 @@ worldwide. This software is distributed without any warranty.
 You should have received a copy of the CC0 Public Domain Dedication along with \r
 this software. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.\r
 \r
-    **Exception:** Portions of the test suite are under different licenses. \r
-    Where this is the case, it is clearly noted in the relevant location.\r
+Exceptions\r
+----------\r
+\r
+Unicode Character Data\r
+~~~~~~~~~~~~~~~~~~~~~~\r
+PDCLib necessarily includes Unicode character data derived from that provided by\r
+Unicode, Inc in its' implementation of the localization and wide character \r
+support (in particular for use by the ctype.h and wctype.h functions.)\r
 \r
-    The license of this code has no bearing upon the licensing of the built \r
-    library (as it does not comprise part of it).\r
+Unicode, Inc licenses that data under a license agreement which can be found at\r
+<http://www.unicode.org/copyright.html#Exhibit1>, or in the file \r
+UNICODE_DATA_LICENSE.txt. found in the same directory as this file.\r
 \r
-    At the time this was written, this exception only applies to portions of the\r
-    printf test suite, which are released under the terms of the 2-clause BSD\r
-    license (see testing/printf_testcases.h for full details)\r
+Test Suite\r
+~~~~~~~~~~\r
+Portions of the test suite are under different licenses. Where this is the case, \r
+it is clearly noted in the relevant location.\r
+\r
+The license of this code has no bearing upon the licensing of the built library \r
+(as it does not comprise part of it).\r
+\r
+At the time this was written, this exception only applies to portions of the \r
+printf test suite, which are released under the terms of the 2-clause BSD \r
+license (see testing/printf_testcases.h for full details)\r
 \r
 Terms for extensions\r
---------------------\r
+====================\r
 Extensions are permitted only if they pass the following tests:\r
 \r
 Pre-existing wide usage\r
@@ -95,7 +111,7 @@ flockfile, funlockfile, getc_unlocked, putc_unlocked, fwrite_unlocked, ...
     the existing I/O functions, and impossible to implement externally\r
 \r
 Internals\r
----------\r
+=========\r
 \r
 As a namespace convention, everything (files, typedefs, functions,\r
 macros) not defined in ISO/IEC 9899 is prefixed with _PDCLIB.\r
@@ -145,7 +161,7 @@ of PDCLib (or link them into the appropriate places). That should be
 all that is actually required to make PDCLib work for your platform.\r
 \r
 Future directions\r
------------------\r
+=================\r
 Obviously, full C89, C99 and C11 conformance; and full support for the \r
 applicable portions of C++98, C++03 and C++11 (the version which acomplishes \r
 this will be christened "1.0").\r
@@ -158,7 +174,7 @@ version of a given function.
 Post 1.0, support for C11 Annexe K "Bounds checking interfaces"\r
 \r
 Development Status\r
-------------------\r
+==================\r
 \r
 ``v0.1 - 2004-12-12``\r
     Freestanding-only C99 implementation without any overlay, and missing\r
@@ -203,7 +219,7 @@ Development Status
     me it cannot be done.) Fixed all known bugs in the v0.4 release.\r
 \r
 Near Future\r
------------\r
+===========\r
 Current development directions are:\r
 \r
 Implement portions of the C11 standard that have a direct impact on the way \r
@@ -212,10 +228,6 @@ PDCLib needs a threading abstraction; therefore, C11's thread library is being
 implemented to provide the backing for this (as there is no purpose in \r
 implementing two abstractions)\r
 \r
-Cleanup portions of <stdio.h>, particularly the backend. _PDCLIB_fillbuffer and\r
-_PDCLIB_flushbuffer in particular do not feel 'well' factored and need to know\r
-too much about FILE's internals. \r
-\r
 Modularize the library somewhat. This can already be seen with components under \r
 "opt/". This structure is preliminary; it will likely change as the process \r
 continues.
\ No newline at end of file