From: Chris Torek <chris.torek@gmail.com>
Date: Sun, 02 Aug 2020 16:20:13 GMT
Subject: Re: [PATCH] t1450: fix quoting of NUL byte when corrupting pack
Message-ID: <CAPx1GvdZNeuQqmYm8G62Zr02k=B5GK69xPw84WnvMCeJU7_amQ@mail.gmail.com>
In-Reply-To: <CAN0heSoYAJkZVG7_TPTo3Osz+FuR__AY5Ykc8OSwzARTotfwcQ@mail.gmail.com>

On Sun, Aug 2, 2020 at 7:35 AM Martin Ågren <martin.agren@gmail.com> wrote:
> No worries! Thanks for having a look at the patch. Is there anything
> that could be done to make this clearer in the commit message? (I find it
> quite awkward to discuss quoting: will the reader understand which
> quoting is part of my own formatting of the message vs which is part of
> the quoting issue I want to get across!?)

This is indeed a problem...

Perhaps something along these lines (generic boilerplate
for any single-quote fixes, that should be adjusted for the
actual fix):

    In the test scripts, the recommended style is, e.g.:

        test_expect_success 'name' '
            multi-line test
            goes here
        '

    When using this style, any single quote in the multi-line
    test section is actually closing the lone single quotes
    that surround it.  To avoid confusion, minimize and/or
    eliminate the use of single quotes here.

Chris