(cc-ing peff, config whiz)
Hi,
Han-Wen Nienhuys wrote:
> Subject: config: document git config getter return value.
micronit: no period at the end of subject line
> ---
> config.h | 10 ++++++++--
> 1 file changed, 8 insertions(+), 2 deletions(-)
May we forge your sign-off? See Documentation/SubmittingPatches section
[[sign-off]] for what this means.
>
> diff --git a/config.h b/config.h
> index b95bb7649..41700f40b 100644
> --- a/config.h
> +++ b/config.h
> @@ -178,10 +178,16 @@ 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);
> +
nit: this blank line feels out of place (though I don't particularly
mind it and wouldn't reroll just for that)
> 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_add_file(struct config_set *cs, const char
> *filename);
This function doesn't take a 'dest' argument. Is the comment meant to
apply to it? If not, can the comment go below it?
> +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);
With a sign-off and whatever subset of the above suggestions makes sense
to you,
Reviewed-by: Jonathan Nieder <[email protected]>
Thanks.
