diff options
| -rw-r--r-- | src/core/vsprintf.c | 37 | ||||
| -rw-r--r-- | src/include/vsprintf.h | 44 |
2 files changed, 41 insertions, 40 deletions
diff --git a/src/core/vsprintf.c b/src/core/vsprintf.c index c0bc759a4..c8ba2c212 100644 --- a/src/core/vsprintf.c +++ b/src/core/vsprintf.c @@ -10,42 +10,7 @@ #define SHRT_SHIFT ((int)((sizeof(unsigned short)*CHAR_BIT) - 4)) #define CHAR_SHIFT ((int)((sizeof(unsigned char)*CHAR_BIT) - 4)) -/** @file - * - * printf and friends. - * - * Etherboot's printf() functions understand the following format - * specifiers: - * - * - Hexadecimal integers - * - @c %[#]x - 4 bytes int (8 hex digits, lower case) - * - @c %[#]X - 4 bytes int (8 hex digits, upper case) - * - @c %[#]lx - 8 bytes long (16 hex digits, lower case) - * - @c %[#]lX - 8 bytes long (16 hex digits, upper case) - * - @c %[#]hx - 2 bytes int (4 hex digits, lower case) - * - @c %[#]hX - 2 bytes int (4 hex digits, upper case) - * - @c %[#]hhx - 1 byte int (2 hex digits, lower case) - * - @c %[#]hhX - 1 byte int (2 hex digits, upper case) - * . - * If the optional # prefix is specified, the output will - * be prefixed with 0x (or 0X). - * - * - Other integers - * - @c %d - decimal int - * . - * Note that any width specification (e.g. the @c 02 in @c %02x) - * will be accepted but ignored. - * - * - Strings and characters - * - @c %c - char - * - @c %s - string - * - @c %m - error message text (i.e. strerror(errno)) - * - * - Etherboot-specific specifiers - * - @c %@ - IP in ddd.ddd.ddd.ddd notation - * - @c %! - MAC address in xx:xx:xx:xx:xx:xx notation - * - */ +/** @file */ /** * Write a formatted string to a buffer. diff --git a/src/include/vsprintf.h b/src/include/vsprintf.h index 2bf200852..553ebeb55 100644 --- a/src/include/vsprintf.h +++ b/src/include/vsprintf.h @@ -1,10 +1,46 @@ #ifndef VSPRINTF_H #define VSPRINTF_H -/* - * Note that we cannot use __attribute__ (( format ( printf, ... ) )) - * to get automatic type checking on arguments, because we use - * non-standard format characters such as "%!" and "%@". +/** @file + * + * printf and friends. + * + * Etherboot's printf() functions understand the following format + * specifiers: + * + * - Hexadecimal integers + * - @c %[#]x - 4 bytes int (8 hex digits, lower case) + * - @c %[#]X - 4 bytes int (8 hex digits, upper case) + * - @c %[#]lx - 8 bytes long (16 hex digits, lower case) + * - @c %[#]lX - 8 bytes long (16 hex digits, upper case) + * - @c %[#]hx - 2 bytes int (4 hex digits, lower case) + * - @c %[#]hX - 2 bytes int (4 hex digits, upper case) + * - @c %[#]hhx - 1 byte int (2 hex digits, lower case) + * - @c %[#]hhX - 1 byte int (2 hex digits, upper case) + * . + * If the optional # prefix is specified, the output will + * be prefixed with 0x (or 0X). + * + * - Other integers + * - @c %d - decimal int + * . + * Note that any width specification (e.g. the @c 02 in @c %02x) + * will be accepted but ignored. + * + * - Strings and characters + * - @c %c - char + * - @c %s - string + * - @c %m - error message text (i.e. strerror(errno)) + * + * - Etherboot-specific specifiers + * - @c %@ - IP address in ddd.ddd.ddd.ddd notation + * - @c %! - MAC address in xx:xx:xx:xx:xx:xx notation + * + * + * @note Unfortunately, we cannot use <tt> __attribute__ (( format ( + * printf, ... ) )) </tt> to get automatic type checking on arguments, + * because we use non-standard format characters such as @c %! and + * @c %@. * */ |