Re: [PATCH v4] json_writer: new routines to create data in JSON format

From: Junio C Hamano <gitster@pobox.com>
Date: Mar 28, 2018, 01:22 UTC
Message-ID: <xmqq8tad9epn.fsf@gitster-ct.c.googlers.com>
In-Reply-To: <ad15ccab-088d-b827-a9fa-c83d397c3479@ramsayjones.plus.com>

Ramsay Jones <ramsay@ramsayjones.plus.com> writes:

Show 12 quoted lines

> BTW, I forgot to mention that you had some whitespace problems
> with this patch, viz:
>
>   $ git log --oneline -1 --check master-json
>   ab643d838 (master-json) json_writer: new routines to create data in JSON format
>   t/helper/test-json-writer.c:280: trailing whitespace.
>   + */ 
>   t/t0019-json-writer.sh:179: indent with spaces.
>   +        "g": 0,
>   t/t0019-json-writer.sh:180: indent with spaces.
>   +        "h": 1
>   $

Yes, and the here-doc that shows expected output looked somewhat old-fashioned without using <<- indent.

Writing it in a way like this might be a reasonable workaround for "indent with spaces", which is only about the leading blank used to indent the line:

<--HT-->sed -e "s/^\|//" <<-\EOF <--HT-->| ... <--HT-->| "g": 0, <--HT-->| "h": 0, <--HT-->| ... <--HT-->EOF

That is, (1) Use the same number of HT as the line that begins the here-doc to indent the expected output; (2) but explicitly mark the left-most column with '|' or something; and then (3) write 8 or more spaces liberally as needed to reproduce the expected output.

I called it a "workaround", as another possibility is to loosen the whitespace rule in t/.gitattributes; we _could_ declare that indent with spaces is OK in these scripts as they contain many expected output examples in here-doc form.

The trailing whitespace after closing C-comment is simply a style violation that is not excuable (I think I've dealt with it when I queued the patch); it should just be fixed.

Thanks.