瀏覽代碼

More doxygen docs

tags/v0.9.3
Michael Brown 19 年之前
父節點
當前提交
0e921cdd9e
共有 2 個文件被更改,包括 16 次插入7 次删除
  1. 13
    2
      src/core/errno.c
  2. 3
    5
      src/include/errno.h

+ 13
- 2
src/core/errno.c 查看文件

@@ -6,7 +6,18 @@
6 6
  *
7 7
  * Error codes and descriptions.
8 8
  *
9
- * This file provides the global variable errno
9
+ * This file provides the global variable #errno and the function
10
+ * strerror().  These function much like their standard C library
11
+ * equivalents.
12
+ *
13
+ * The error numbers used by Etherboot are a superset of those defined
14
+ * by the PXE specification version 2.1.  See errno.h for a listing of
15
+ * the error values.
16
+ *
17
+ * To save space in ROM images, error string tables are optional.  Use
18
+ * the ERRORMSG_XXX options in config.h to select which error string
19
+ * tables you want to include.  If an error string table is omitted,
20
+ * strerror() will simply return the text "Error 0x<errno>".
10 21
  *
11 22
  */
12 23
 
@@ -29,7 +40,7 @@ static struct errortab errortab_end[0] __table_end(errortab);
29 40
  * @ret strerror	Pointer to error text
30 41
  *
31 42
  * If the error is not found in the linked-in error tables, generates
32
- * a generic "Error 0x0000" message.
43
+ * a generic "Error 0x<errno>" message.
33 44
  *
34 45
  * The pointer returned by strerror() is valid only until the next
35 46
  * call to strerror().

+ 3
- 5
src/include/errno.h 查看文件

@@ -1,11 +1,9 @@
1 1
 #ifndef ERRNO_H
2 2
 #define ERRNO_H
3 3
 
4
-/*
5
- * We define error codes that are a superset of those mentioned in the
6
- * PXE specification.  Various error string tables may be compiled in
7
- * if required; if not compiled in, strerror(errno) will produce the
8
- * text "error 0x<errno>".
4
+/** @file
5
+ *
6
+ * Error codes
9 7
  *
10 8
  */
11 9
 

Loading…
取消
儲存