diff options
author | Michael Brown | 2005-05-18 17:28:33 +0200 |
---|---|---|
committer | Michael Brown | 2005-05-18 17:28:33 +0200 |
commit | 0e921cdd9ed244702f0b4ea17aaf422c291d4d61 (patch) | |
tree | d9acbcd06e4974d489ccde516d56d9cfd47a67ac /src/core/errno.c | |
parent | Add include directories as source dirs (diff) | |
download | ipxe-0e921cdd9ed244702f0b4ea17aaf422c291d4d61.tar.gz ipxe-0e921cdd9ed244702f0b4ea17aaf422c291d4d61.tar.xz ipxe-0e921cdd9ed244702f0b4ea17aaf422c291d4d61.zip |
More doxygen docs
Diffstat (limited to 'src/core/errno.c')
-rw-r--r-- | src/core/errno.c | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/src/core/errno.c b/src/core/errno.c index e72acdd0..83c8564b 100644 --- a/src/core/errno.c +++ b/src/core/errno.c @@ -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(). |