Subject: Re: [PATCH v2 1/2] t/lib-read-tree-m-3way: replace double quotes with single quotes

From: Junio C Hamano <[email-masked]>
Date: Tue, 01 Feb 2022 15:51:45 -0800

Shaoxuan Yuan <[email-masked]> writes:

> Signed-off-by: Shaoxuan Yuan <[email-masked]>
> ---
>
> This commit simply converts the old style (double quotes) to
> a modern style (single quotes), e.g.
>
> -test_expect_success \
> -    'adding test file SS' \
> -    'git update-index --add SS'
> +test_expect_success 'adding test file SS' '
> +    git update-index --add SS
> +'

The old one does not use "double quotes", though ;-)

Also, the above belongs to the log message proper, as it would help
readers of "git log" in the future, as opposed to merely helping
reviewers only while the patch is under review (e.g. differences
between v1 and v2 is a good thing to write after "---", as "git log"
readers will not have access to v1, and will not even want to know
that there was v1).

Documentation/SubmittingPatches has more hints on the log message
writing to help anybody who wants to participate in this project.

 * The title summarizes what problem is being solved (yours is
   fine).

 * Then the status quo is explained in the present tense.

 * Readers are made to realize what is wrong about the status quo.

 * The approach taken to solve that problem is outlined.

 * Then orders are given to the codebase to "become like so" in
   imperative mood.

Applying the above to this patch:

	t/lib-read-tree-m-3way: modernize style

	Many invocations of the test_expect_success command in this
	file are written in old style where the command, an optional
	prerequisite, and the test title are written on separate
	lines, and the executable script string begins on its own
	line, and these lines are pasted together with backslashes
	as necessary.

	An invocation of the test_expect_success command in modern
	test scripts however writes the prerequisite and the title
	on the same line as the test_expect_success command itself,
	and ends the line with a single quote that begins the
	executable script string.

	Update the style for uniformity.

or something along that line, perhaps?