summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar Han-Wen Nienhuys <hanwen@google.com>2018-08-06 16:33:12 +0200
committerLibravatar Junio C Hamano <gitster@pobox.com>2018-08-06 09:21:38 -0700
commit8ad169c4ba2f0897cd378bccd1c08b04e116c787 (patch)
tree906629401d3ad87711fe7ac2f4781198beb9c435
parentGit 2.18 (diff)
downloadtgif-8ad169c4ba2f0897cd378bccd1c08b04e116c787.tar.xz
config: document git config getter return value
Signed-off-by: Han-Wen Nienhuys <hanwen@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--config.h7
1 files changed, 6 insertions, 1 deletions
diff --git a/config.h b/config.h
index cdac2fc73e..38e55c86bf 100644
--- 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);