From: Shreyansh Paliwal <shreyanshpaliwalcmsmn@gmail•com>
To: git@vger•kernel.org
Cc: valusoutrik@gmail•com
Subject: Re: [PATCH] doc: fix repo_config documentation reference
Date: Thu, 5 Feb 2026 18:41:25 +0530 [thread overview]
Message-ID: <20260205131132.44282-1-shreyanshpaliwalcmsmn@gmail.com> (raw)
In-Reply-To: <pull.2187.git.git.1770293021383.gitgitgadget@gmail.com>
> Since documentation was moved from Documenation/
> technical/api-config to inside the config.h
> This might help newcomers, by pointing them to the
> right place to get documentation about repo_config
Some suggestions,
* s/Documenation/Documentation
* ~70 cols is the practical followed line wrapping, so you can follow that
for best readability.
* First describe the current problem statement which describes the
current state in the present tense like,
In MyFirstContribution.adoc, the link to the repo_config()
documentation is invalid because the documentation related was moved
to a different file.
* Then you instruct somebody to make changes to the code to make it better like,
Replace the path for the repo_config() documentation from
'Documenation/technical/api-config' to 'config.h'.
* Then you can state your additional explainations, references and/or
advantages, whatever seems relevant for the change you just stated.
Best,
Shreyansh
next prev parent reply other threads:[~2026-02-05 13:11 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-02-05 12:03 [PATCH] doc: fix repo_config documentation reference Soutrik Das via GitGitGadget
2026-02-05 13:11 ` Shreyansh Paliwal [this message]
2026-02-06 6:01 ` SoutrikDas
2026-02-06 6:21 ` [GSOC PATCH v2] " SoutrikDas
2026-02-06 16:39 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260205131132.44282-1-shreyanshpaliwalcmsmn@gmail.com \
--to=shreyanshpaliwalcmsmn@gmail$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=valusoutrik@gmail$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox