git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Shaoxuan Yuan <shaoxuan.yuan02@gmail.com>
Cc: git@vger.kernel.org, sunshine@sunshineco.com
Subject: Re: [PATCH v2 1/2] t/lib-read-tree-m-3way: replace double quotes with single quotes
Date: Tue, 01 Feb 2022 15:51:45 -0800	[thread overview]
Message-ID: <xmqq35l29mcu.fsf@gitster.g> (raw)
In-Reply-To: <20220130094357.515335-2-shaoxuan.yuan02@gmail.com> (Shaoxuan Yuan's message of "Sun, 30 Jan 2022 17:43:56 +0800")

Shaoxuan Yuan <shaoxuan.yuan02@gmail.com> writes:

> Signed-off-by: Shaoxuan Yuan <shaoxuan.yuan02@gmail.com>
> ---
>
> 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?

  reply	other threads:[~2022-02-01 23:51 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-01-23  6:03 [GSoC][PATCH] lib-read-tree-m-3way: modernize a test script (style) Shaoxuan Yuan
2022-01-27 10:54 ` Shaoxuan Yuan
2022-01-28  8:34 ` Eric Sunshine
2022-01-28  9:51   ` Shaoxuan Yuan
2022-02-05 11:59     ` Eric Sunshine
2022-02-07 13:10       ` Shaoxuan Yuan
2022-01-30  9:43 ` [PATCH v2 0/2] t/lib-read-tree-m-3way: modernize a test script Shaoxuan Yuan
2022-01-30  9:43   ` [PATCH v2 1/2] t/lib-read-tree-m-3way: replace double quotes with single quotes Shaoxuan Yuan
2022-02-01 23:51     ` Junio C Hamano [this message]
2022-02-02  4:52       ` Shaoxuan Yuan
2022-01-30  9:43   ` [PATCH v2 2/2] t/lib-read-tree-m-3way: replace spaces with tabs Shaoxuan Yuan
2022-02-01 23:57     ` Junio C Hamano
2022-02-02  4:59       ` Shaoxuan Yuan
2022-02-02  6:42 ` [PATCH v3 1/2] t/lib-read-tree-m-3way: modernize style Shaoxuan Yuan
2022-02-02  6:43   ` [PATCH v3 2/2] t/lib-read-tree-m-3way: indent with tabs Shaoxuan Yuan
2022-02-07 11:54     ` Christian Couder
2022-02-08  1:47       ` Shaoxuan Yuan
2022-02-07 11:41   ` [PATCH v3 1/2] t/lib-read-tree-m-3way: modernize style Christian Couder
2022-02-08  1:43     ` Shaoxuan Yuan
2022-02-08  3:24 ` [PATCH v4 0/2] t/lib-read-tree-m-3way: modernize a test script Shaoxuan Yuan
2022-02-08  3:24   ` [PATCH v4 1/2] t/lib-read-tree-m-3way: modernize style Shaoxuan Yuan
2022-02-08  3:24   ` [PATCH v4 2/2] t/lib-read-tree-m-3way: indent with tabs Shaoxuan Yuan

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqq35l29mcu.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=shaoxuan.yuan02@gmail.com \
    --cc=sunshine@sunshineco.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).