Re: [RFC PATCH 0/6] various documentation bits

From: Abhishek Kumar <abhishekkumar8222@gmail.com>
Date: May 17, 2020, 07:42 UTC
Message-ID: <20200517074258.GA1381@Abhishek-Arch>
In-Reply-To: <1589681624-36969-1-git-send-email-keni@hers.com>

Hello Kenneth,

On Sat, May 16, 2020 at 10:13:38PM -0400, Kenneth Lorber wrote:

Show 33 quoted lines

> From: Kenneth Lorber <keni@his.com>
> 
> This started as an effort to understand this section of config.txt:
>   When inventing new variables for use in your own tool, make sure their
>   names do not conflict with those that are used by Git itself and
>   other popular tools, and describe them in your documentation.
> and grew from there.
> 
> I don't expect this to be adopted as is, but I've found it much easier
> to discuss something concrete rather than an abstract "this is
> incomplete" or "this is hard to find."
> 
> Cut from master.
> 
> keni (6):
>   Tell the glossary about core.hooksPath
>   Add bit on extending git to Hacking Git
>   Add namespace collision avoidance guidelines file
>   Include NAMESPACE COLLISIONS doc into gitrepository-layout.txt
>   Tell config.txt about NAMESPACE COLLISIONS
>   Add NAMESPACE COLLISIONS reference to Hacking Git
> 
>  Documentation/config.txt                      |  4 +-
>  Documentation/gitrepository-layout.txt        |  2 +
>  Documentation/glossary-content.txt            | 10 ++-
>  .../technical/namespace-collisions.txt        | 86 +++++++++++++++++++
>  Documentation/user-manual.txt                 |  9 ++
>  5 files changed, 106 insertions(+), 5 deletions(-)
>  create mode 100644 Documentation/technical/namespace-collisions.txt
> 
> -- 
> 2.17.1
>

Some general notes about your patch series:

1. Conventionally, we prefix the first line with "area: " where the area
is a filename or identifier for general area of the code being modified.
It's customary to start the remainder of the first line after "area: "
with a lower-case letter.

For example, your commit titles could have been:
- doc: tell the glossary about core.hooksPath
- doc: add bit on extending git to hacking Git

and so on.

Check out SubmittingPatches for more information.

2. We generally don't have a line like in our patches:

> From Kenneth Lorber <keni@his.com>

Between the author information and the signed-off-by, it's redundant.

3. You could probably join the patches 3 to 6 together. Or maybe
introduce namespace-collisions.txt in third patch and add references in
all other files in a new, fourth patch.

Thanks for the contribution!

Regards Abhishek