From 5a08b434c7ddecb9cab0f8aedd9db679ca35395c Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Tue, 18 Mar 2008 00:48:23 +0000
Subject: [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.
---
 src/include/gpxe/settings.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'src/include')

diff --git a/src/include/gpxe/settings.h b/src/include/gpxe/settings.h
index f30bbfbc7..1b9c059be 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,
-- 
cgit v1.2.3-55-g7522