Re: [RFC PATCH 1/2] config: make git_config_include() static

From: Jeff King <peff@peff.net>
Date: Oct 12, 2021, 23:07 UTC
Message-ID: <YWYVM8dzC/w8t7vk@coredump.intra.peff.net>
In-Reply-To: <179df6d6adfe460de7413e1fb1dff6bce185ae0e.1634077795.git.jonathantanmy@google.com>

On Tue, Oct 12, 2021 at 03:57:22PM -0700, Jonathan Tan wrote:

> It is not used from outside the file in which it is declared.

Makes sense. We used to use it from builtin/config.c, but that went away in e895589883 (git-config: use git_config_with_options, 2012-10-23).

Show 11 quoted lines

> diff --git a/config.h b/config.h
> index 147f5e0490..b11b0be09a 100644
> --- a/config.h
> +++ b/config.h
> @@ -126,6 +126,8 @@ int git_default_config(const char *, const char *, void *);
>  /**
>   * Read a specific file in git-config format.
>   * This function takes the same callback and data parameters as `git_config`.
> + *
> + * Unlike git_config(), this function does not respect includes.
>   */

Breaking out the relevant caller-facing parts of the documentation like this is a nice touch.

And the rest of the patch looks good to me.

-Peff