Re: [GSoC] Microproject: Updating Documentation

From: JAYATHEERTH K <jayatheerthkulkarni2005@gmail.com>
Date: Mar 9, 2025, 14:55 UTC
Message-ID: <CA+rGoLfwetxdij9ZLZx7bcxNXfzTi7hRSSkJu+AMhVX6W02v9g@mail.gmail.com>
In-Reply-To: <CA+rGoLfTJSHQZTvNBgfcMmGjJwqak+wGHh9PRhHfqHSxB2p6-g@mail.gmail.com>

Show 10 quoted lines

> 3. Incorrect Config Function Reference In the "Implementation" section
> (https://github.com/git/git/blob/master/Documentation/MyFirstContribution.adoc#implementation),
> it mentions git_config(...), but config.c doesn’t define it.
> I had to use repo_config(...) instead, which isn’t documented here.
> Proposed Fix: Update the doc to use repo_config(...) and explain its usage.
> Additional Note: I can also edit the config files to appropriately
> correct the git_config() function if needed, but I’d require some
> guidance as to not mess up other programs while doing this as I
> believe config.c/config.h is used by a lot of other files too.
>

A small clarification on this I made a small error where I said git_config(...) was not defined, I actually did a grep check and found the wrapper function(#ifdef USE_THE_REPOSITORY_VARIABLE) , here's my updated proposed fix

To update the MyFirstContribution.adoc to use repo_config as the *repo is getting involved with the cmd_psuh. As this would be confusing for many people at the start.

Thank you, Jay