More doxygen docs
authorMichael Brown <mcb30@etherboot.org>
Wed, 18 May 2005 15:28:33 +0000 (15:28 +0000)
committerMichael Brown <mcb30@etherboot.org>
Wed, 18 May 2005 15:28:33 +0000 (15:28 +0000)
src/core/errno.c
src/include/errno.h

index e72acdd..83c8564 100644 (file)
@@ -6,7 +6,18 @@
  *
  * Error codes and descriptions.
  *
- * This file provides the global variable errno
+ * This file provides the global variable #errno and the function
+ * strerror().  These function much like their standard C library
+ * equivalents.
+ *
+ * The error numbers used by Etherboot are a superset of those defined
+ * by the PXE specification version 2.1.  See errno.h for a listing of
+ * the error values.
+ *
+ * To save space in ROM images, error string tables are optional.  Use
+ * the ERRORMSG_XXX options in config.h to select which error string
+ * tables you want to include.  If an error string table is omitted,
+ * strerror() will simply return the text "Error 0x<errno>".
  *
  */
 
@@ -29,7 +40,7 @@ static struct errortab errortab_end[0] __table_end(errortab);
  * @ret strerror       Pointer to error text
  *
  * If the error is not found in the linked-in error tables, generates
- * a generic "Error 0x0000" message.
+ * a generic "Error 0x<errno>" message.
  *
  * The pointer returned by strerror() is valid only until the next
  * call to strerror().
index a3c7fbb..e122d9c 100644 (file)
@@ -1,11 +1,9 @@
 #ifndef ERRNO_H
 #define ERRNO_H
 
-/*
- * We define error codes that are a superset of those mentioned in the
- * PXE specification.  Various error string tables may be compiled in
- * if required; if not compiled in, strerror(errno) will produce the
- * text "error 0x<errno>".
+/** @file
+ *
+ * Error codes
  *
  */