[Settings] show_setting() functions return snprintf()-style length.
[people/mcb30/gpxe.git] / src / include / gpxe / settings.h
index f30bbfb..1b9c059 100644 (file)
@@ -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,