config: document git config getter return value
authorHan-Wen Nienhuys <hanwen@google.com>
Mon, 6 Aug 2018 14:33:12 +0000 (16:33 +0200)
committerJunio C Hamano <gitster@pobox.com>
Mon, 6 Aug 2018 16:21:38 +0000 (09:21 -0700)
Signed-off-by: Han-Wen Nienhuys <hanwen@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
config.h
index cdac2fc73e6a2d0bc3230848425557a23e88d0bf..38e55c86bf6a04d0cd9be0a4e709f0cdd3bf606f 100644 (file)
--- a/config.h
+++ b/config.h
@@ -179,9 +179,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);