git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
Shaoxuan Yuan <shaoxuan.yuan02@gmail.com>
Date
Feb 2, 2022, 04:52 UTC
Message-ID
<CAJyCBOTs-b98q7b7THCZvqS=yVqgoOm4XshoOAQyuusy6S6pBQ@mail.gmail.com>
In-Reply-To
<xmqq35l29mcu.fsf@gitster.g>
On Wed, Feb 2, 2022 at 7:51 AM Junio C Hamano <gitster@pobox.com> wrote:
Show 8 quoted lines
> 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).

Thanks, think I should put the explanation message above the "---" so "git log" has it. It's a really helpful tip (I think I was too cautious to put more message above "---" so I just left it blank but a commit title).

Show 35 quoted lines
> 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?

Another thanks. I should've been reading throughout the details in Documentation/SubmittingPatches and I'm doing so.

I will try to get the format straight as per the suggestions (learned a lot from them) and documentation then submit a v3 sooner :-)

-- Thanks, Shaoxuan

Previous: Junio C HamanoNext: Shaoxuan Yuan
Message 13 of 22 in “lib-read-tree-m-3way: modernize a test script (style)”
  1. Shaoxuan YuanJan 23, 2022
  2. Shaoxuan YuanJan 27, 2022
  3. Eric SunshineJan 28, 2022
  4. Shaoxuan YuanJan 28, 2022
  5. Eric SunshineFeb 5, 2022
  6. Shaoxuan YuanFeb 7, 2022
  7. 0/2 t/lib-read-tree-m-3way: modernize a test scriptShaoxuan Yuan, Jan 30, 2022
  8. 2/2 t/lib-read-tree-m-3way: replace spaces with tabsShaoxuan Yuan, Jan 30, 2022
  9. Junio C HamanoFeb 1, 2022
  10. Shaoxuan YuanFeb 2, 2022
  11. 1/2 t/lib-read-tree-m-3way: replace double quotes with single quotesShaoxuan Yuan, Jan 30, 2022
  12. Junio C HamanoFeb 1, 2022
  13. Shaoxuan YuanFeb 2, 2022
  14. 1/2 t/lib-read-tree-m-3way: modernize styleShaoxuan Yuan, Feb 2, 2022
  15. 2/2 t/lib-read-tree-m-3way: indent with tabsShaoxuan Yuan, Feb 2, 2022
  16. Christian CouderFeb 7, 2022
  17. Shaoxuan YuanFeb 8, 2022
  18. Christian CouderFeb 7, 2022
  19. Shaoxuan YuanFeb 8, 2022
  20. 0/2 t/lib-read-tree-m-3way: modernize a test scriptShaoxuan Yuan, Feb 8, 2022
  21. 1/2 t/lib-read-tree-m-3way: modernize styleShaoxuan Yuan, Feb 8, 2022
  22. 2/2 t/lib-read-tree-m-3way: indent with tabsShaoxuan Yuan, Feb 8, 2022

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.