Re: [Newcomer] Question about inconsistencies in MyFirstContribution.adoc

From: Shreyansh Paliwal <shreyanshpaliwalcmsmn@gmail.com>
Date: Feb 4, 2026, 11:13 UTC
Message-ID: <20260204111343.71975-1-shreyanshpaliwalcmsmn@gmail.com>
In-Reply-To: <CAPHqhPmDSh8WRwYt0TJUQQajM5r84m6tc6RZsiM-YzeBbxzwaw@mail.gmail.com>

Show 10 quoted lines

> Hi everyone,
> Newcomer here, while going through the MyFirstContribution.adoc I
> noticed some small inconsistencies , which might not be a problem to
> anyone really, but since I was doubtful I am writing here.
> 
> > Add a line to #include "config.h" and #include"repository.h". Then, add the following bits to the function body: function body
> 
> And then the tutorial uses `git_default_config` , which I am assuming
> used to be in `config.h` but now it's in `environment.h`.
>

Yes this is a valid inconsistency, but this is fixed in a recent patch [1]. It is currently in the next branch.

Show 23 quoted lines

> 
> Another small thing was
> > There are a number of single-key lookup functions like this one; you can see them all (and more info about how to use repo_config()) in Documentation/technical/api-config.adoc
> 
> But There is no api-config.adoc in ./Documentation/technical
> 
> I couldn't find any other place where the repo_config() was explained
> , Inside the Documentation folder it has been mentioned in 4 files
> - MyFirstContribution.adoc : excluding this
> - MyFirstObjectWalk.adoc : excluding this as well
> - user-manual.adoc : used to explain what `builtin/cat-file.c` was doing
> - 2.50.0.adoc : is about a release ?
> So I assume the thing that the tutorial refers to is currently not present ?
> 
> While writing this mail , I checked two previous Patch mails:
> One was about a patch by Arnav Kapoor (
> https://lore.kernel.org/git/pull.1972.git.git.1748005233977.gitgitgadget@gmail.com/
> ) another one was probably about rejecting this patch ? And then
> From this ( https://lore.kernel.org/git/xmqq8qmso59i.fsf@gitster.g/#t
> ) I am assuming repo-config used to be called git-config , but a
> search on git-config shows up too many matches , and I think i should
> stop here and ask for advice.
>

Actually the documentation for repo_config was shifted to config.h, to make it easier, see patch [2].

You can replace 'Documentation/technical/api-config.adoc' with 'config.h'.

> I believe this won't count as a microproject for gsoc , but
> nonetheless, it may or may not help newcomers.
> Is this a possible patch ?
>

Every change, even if it is a small documentation change is an improvement, but I would suggest apart from this doc change you can look into [3] for some more microproject ideas.

Best, Shreyansh

[1]- https://lore.kernel.org/git/20260112195625.391821-1-shreyanshpaliwalcmsmn@gmail.com/ [2]- https://github.com/git/git/commit/6c96630cb0900446f7069f64d3d58bac539c0a58 [3]- https://git.github.io/SoC-2025-Microprojects/