Re: [PATCH v3] doc: Don't echo sed command for manpage-base-url.xsl

From: Junio C Hamano <gitster@pobox.com>
Date: Aug 29, 2018, 19:19 UTC
Message-ID: <xmqqtvnc94vi.fsf@gitster-ct.c.googlers.com>
In-Reply-To: <20180829165540.GB170940@aiede.svl.corp.google.com>

Jonathan Nieder <jrnieder@gmail.com> writes:

Show 10 quoted lines

> Tim Schumacher wrote:
>
>> Subject: doc: Don't echo sed command for manpage-base-url.xsl
>
> Cribbing from my review of v2: a description like
>
> 	Documentation/Makefile: make manpage-base-url.xsl generation quieter
>
> would make it more obvious what this does when viewed in "git log
> --oneline".

Sounds good; let's take it.

>> Previously, the sed command for generating manpage-base-url.xsl
>> was printed to the console when being run.

The convention is that we talk about the state before the current series in question is applied in the present tense, so "previously" is not needed. Perhaps

    The exact sed command to generate manpage-base-url.xsl appears in
    the output, unlike the rules for other files that by default only
    show summary.

is sufficient. The output is not always going to "the console", and it is not like we change behaviour depending on where the output is going, so it is misleading to say "the console" (iow, the phrase "to the console" has negative information density in the above sentence).

>> Make the console output for this rule similiar to all the
>> other rules by printing a short status message instead of
>> the whole command.

Likewise, s/console //;

I'll all do the above tweaks while queueing.

Thanks, both.

Show 16 quoted lines

>>
>> Signed-off-by: Tim Schumacher <timschumi@gmx.de>
>> ---
>>  Documentation/Makefile | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> Oh!  Ignore my reply to v2; looks like you anticipated what I was
> going to suggest already.  For next time, if you include a note about
> what changed between versions after the --- delimiter, that can help
> save some time.
>
> With or without the suggested commit message tweak,
>
> Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>
>
> Thank you.