Re: [PATCH/FINAL] Documentation/git-submodule: cleanup

From: Stefan Beller <sbeller@google.com>
Date: Jun 22, 2017, 19:13 UTC
Message-ID: <CAGZ79kYAJR7WXn9p1tGXTWTw9V4kpBX9g_W2_dy0AE9OLFPcvw@mail.gmail.com>
In-Reply-To: <xmqqr2ybkfj7.fsf@gitster.mtv.corp.google.com>

On Thu, Jun 22, 2017 at 12:07 PM, Junio C Hamano <gitster@pobox.com> wrote:

Show 25 quoted lines

> Kaartic Sivaraam <kaarticsivaraam91196@gmail.com> writes:
>
>> The "add" section for 'git-submodule' is redundant in
>> its description and the short synopsis line. Fix it.
>>
>> Remove the redundant mentioning of the 'repository' argument
>> being mandatory.
>>
>> The text is hard to read because of back-references, so remove
>> those.
>>
>> Replace the word "humanish" by "canonical" as that conveys better
>> what we do to guess the path.
>>
>> While at it, quote all occurrences of '.gitmodules' as that is an
>> important file in the submodule context, also link to it on its
>> first mention.
>>
>> Helped-by: Stefan Beller <sbeller@google.com>
>> Signed-off-by: Kaartic Sivaraam <kaarticsivaraam91196@gmail.com>
>> ---
>
> Stefan, do you want to add a Reviewed-by: to this one?  I've scanned
> it over and overall it looked OK (iow I didn't find anything worth
> complaining about).

I found it a pleasant read, thanks.

As all occurrences of '.gitmodules' are touched, I suspect we will run into a conflict with sb/submodule-doc, such that I will rebase on top of this.

Thanks, Stefan