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

[Kenneth Lorber <keni@his.com>]

> On May 17, 2020, at 2:39 PM, Junio C Hamano <gitster@pobox.com> wrote:
> 
> Abhishek Kumar <abhishekkumar8222@gmail.com> writes:
> 
>> 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.
> 
> Good suggestion.
> 
>> 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.
> 
> Carefully inspect the e-mail header and in-body header ;-)  
> 
> The author identity must match the identity written for the
> signed-off-by trailer, so the in-body header becomes needed
> when the From: e-mail header does not match the true author,
> like these patches.

Email/git send-email configuration issue.  They should match on v2, if I'm lucky.

> 
>> 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.
> 
> Perhaps, but I'd rather not to see a rule that hasn't been applied
> even once in the real situation written down like a law.  I'd prefer
> to see us gain experience by interacting tool authors on the list
> and learn what their concerns and pain-points are.

This tool author/git admin went for a patch to discuss.

I assume from the above there has been no interaction before, so at the very least we need a pointer to the list for this topic to cause that interaction to occur.

As I noted in another part of this thread, we can certainly make it less of a law and more of a recommendation or hint.

I listed some of the issues elsewhere; if that isn't quite what you are looking for I can expand on it.

> 
> Thansk.

Thank you,
Keni