Merge branch 'hn/config-in-code-comment'

Header update.

* hn/config-in-code-comment:
config: document git config getter return value

diff --git a/config.h b/config.h
index 1d56fe6aa28fe1a244118f00733e3829217b71ca..2d5c18b05f85e1a6a7f954442f5d7565e9769212 100644 (file)
--- a/config.h
+++ b/config.h
@@ -189,9 +189,14 @@ struct config_set {
 
 extern void git_configset_init(struct config_set *cs);
 extern int git_configset_add_file(struct config_set *cs, const char *filename);
-extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);
 extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
 extern void git_configset_clear(struct config_set *cs);
+
+/*
+ * These functions return 1 if not found, and 0 if found, leaving the found
+ * value in the 'dest' pointer.
+ */
+extern int git_configset_get_value(struct config_set *cs, const char *key, const char **dest);
 extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
 extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
 extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);