Comment cleanups.

[pdclib] / platform / example / internals / _PDCLIB_config.h

diff --git a/platform/example/internals/_PDCLIB_config.h b/platform/example/internals/_PDCLIB_config.h
index 0059a7f6d9b9c41975e43bbb7eef0d46f8215619..88f8a15d7144918e72a05cae5ffca560162a7e09 100644 (file)
--- a/platform/example/internals/_PDCLIB_config.h
+++ b/platform/example/internals/_PDCLIB_config.h
@@ -1,5 +1,3 @@
-/* $Id$ */
-
 /* Internal PDCLib configuration <_PDCLIB_config.h>
    (Generic Template)
 
@@ -7,6 +5,9 @@
    Permission is granted to use, modify, and / or redistribute at will.
 */
 
+#ifndef _PDCLIB_CONFIG_H
+#define _PDCLIB_CONFIG_H _PDCLIB_CONFIG_H
+
 /* -------------------------------------------------------------------------- */
 /* Misc                                                                       */
 /* -------------------------------------------------------------------------- */
@@ -37,8 +38,8 @@
 /* strerror() and perror() functions. (If you change this value because you   */
 /* are using additional errno values, you *HAVE* to provide appropriate error */
 /* messages for *ALL* locales.)                                               */
-/* Default is 2 (0, ERANGE, EDOM).                                            */
-#define _PDCLIB_ERRNO_MAX 3
+/* Default is 4 (0, ERANGE, EDOM, EILSEQ).                                    */
+#define _PDCLIB_ERRNO_MAX 4
 
 /* -------------------------------------------------------------------------- */
 /* Integers                                                                   */
@@ -341,6 +342,9 @@ typedef int _PDCLIB_fd_t;
    an uppercase 'E', and there is no mechanics in <errno.h> to unmask that
    particular value (for exactly that reason).
 
+   There also is no error message available for this value through either the
+   strerror() or perror() functions. It is being reported as "unknown" error.
+
    The idea is that you scan the source of PDCLib for occurrences of this macro
    and replace _PDCLIB_ERROR with whatever additional errno value you came up
    with for your platform.
@@ -351,3 +355,4 @@ typedef int _PDCLIB_fd_t;
 */
 #define _PDCLIB_ERROR  4
 
+#endif