summaryrefslogtreecommitdiffstats
path: root/src/include/gpxe/settings.h
diff options
context:
space:
mode:
authorMichael Brown2008-03-18 01:48:23 +0100
committerMichael Brown2008-03-18 01:48:23 +0100
commit5a08b434c7ddecb9cab0f8aedd9db679ca35395c (patch)
tree661b193f21aeaf89aafaf8d92d28ae39444f85aa /src/include/gpxe/settings.h
parentMerge branch 'pxerom-pmm' (diff)
downloadipxe-5a08b434c7ddecb9cab0f8aedd9db679ca35395c.tar.gz
ipxe-5a08b434c7ddecb9cab0f8aedd9db679ca35395c.tar.xz
ipxe-5a08b434c7ddecb9cab0f8aedd9db679ca35395c.zip
[Settings] show_setting() functions return snprintf()-style length.
show_setting() and related functions now return an "actual length" in the style of snprintf(). This is to allow consumers to allocate buffers large enough to hold the formatted setting.
Diffstat (limited to 'src/include/gpxe/settings.h')
-rw-r--r--src/include/gpxe/settings.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/include/gpxe/settings.h b/src/include/gpxe/settings.h
index f30bbfbc..1b9c059b 100644
--- a/src/include/gpxe/settings.h
+++ b/src/include/gpxe/settings.h
@@ -48,7 +48,7 @@ struct config_setting_type {
* @v setting Configuration setting
* @v buf Buffer to contain value
* @v len Length of buffer
- * @ret rc Return status code
+ * @ret len Length of formatted value, or negative error
*/
int ( * show ) ( struct config_context *context,
struct config_setting *setting,
@@ -108,7 +108,7 @@ struct config_setting {
* @v setting Configuration setting
* @v buf Buffer to contain value
* @v len Length of buffer
- * @ret rc Return status code
+ * @ret len Length of formatted value, or negative error
*/
static inline int show_setting ( struct config_context *context,
struct config_setting *setting,