On Wed, Feb 2, 2022 at 7:51 AM Junio C Hamano <gitster@xxxxxxxxx> wrote: > 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). > 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
