diff mbox series

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

Message ID 20220130094357.515335-2-shaoxuan.yuan02@gmail.com (mailing list archive)
State Superseded
Headers show
Series t/lib-read-tree-m-3way: modernize a test script | expand

Commit Message

Shaoxuan Yuan Jan. 30, 2022, 9:43 a.m. UTC 
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
+'

 t/lib-read-tree-m-3way.sh | 154 +++++++++++++++++++-------------------
 1 file changed, 77 insertions(+), 77 deletions(-)

Comments

Junio C Hamano Feb. 1, 2022, 11:51 p.m. UTC | #1 
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?
Shaoxuan Yuan Feb. 2, 2022, 4:52 a.m. UTC | #2 
On Wed, Feb 2, 2022 at 7:51 AM Junio C Hamano <gitster@pobox.com> 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
diff mbox series

Patch

diff --git a/t/lib-read-tree-m-3way.sh b/t/lib-read-tree-m-3way.sh
index 168329adbc..3c17cb7f80 100644
--- a/t/lib-read-tree-m-3way.sh
+++ b/t/lib-read-tree-m-3way.sh
@@ -8,16 +8,16 @@  do
         p=$a$b
 	echo This is $p from the original tree. >$p
 	echo This is Z/$p from the original tree. >Z/$p
-	test_expect_success \
-	    "adding test file $p and Z/$p" \
-	    'git update-index --add $p &&
-	    git update-index --add Z/$p'
+	test_expect_success "adding test file $p and Z/$p" '
+	    git update-index --add $p &&
+	    git update-index --add Z/$p
+    '
     done
 done
 echo This is SS from the original tree. >SS
-test_expect_success \
-    'adding test file SS' \
-    'git update-index --add SS'
+test_expect_success 'adding test file SS' '
+    git update-index --add SS
+'
 cat >TT <<\EOF
 This is a trivial merge sample text.
 Branch A is expected to upcase this word, here.
@@ -30,12 +30,12 @@  At the very end, here comes another line, that is
 the word, expected to be upcased by Branch B.
 This concludes the trivial merge sample file.
 EOF
-test_expect_success \
-    'adding test file TT' \
-    'git update-index --add TT'
-test_expect_success \
-    'prepare initial tree' \
-    'tree_O=$(git write-tree)'
+test_expect_success 'adding test file TT' '
+    git update-index --add TT
+'
+test_expect_success 'prepare initial tree' '
+    tree_O=$(git write-tree)
+'
 
 ################################################################
 # Branch A and B makes the changes according to the above matrix.
@@ -45,48 +45,48 @@  test_expect_success \
 
 to_remove=$(echo D? Z/D?)
 rm -f $to_remove
-test_expect_success \
-    'change in branch A (removal)' \
-    'git update-index --remove $to_remove'
+test_expect_success 'change in branch A (removal)' '
+    git update-index --remove $to_remove
+'
 
 for p in M? Z/M?
 do
     echo This is modified $p in the branch A. >$p
-    test_expect_success \
-	'change in branch A (modification)' \
-        "git update-index $p"
+    test_expect_success 'change in branch A (modification)' '
+        git update-index $p
+    '
 done
 
 for p in AN AA Z/AN Z/AA
 do
     echo This is added $p in the branch A. >$p
-    test_expect_success \
-	'change in branch A (addition)' \
-	"git update-index --add $p"
+    test_expect_success 'change in branch A (addition)' '
+	    git update-index --add $p
+    '
 done
 
 echo This is SS from the modified tree. >SS
 echo This is LL from the modified tree. >LL
-test_expect_success \
-    'change in branch A (addition)' \
-    'git update-index --add LL &&
-     git update-index SS'
+test_expect_success 'change in branch A (addition)' '
+    git update-index --add LL &&
+    git update-index SS
+'
 mv TT TT-
 sed -e '/Branch A/s/word/WORD/g' <TT- >TT
 rm -f TT-
-test_expect_success \
-    'change in branch A (edit)' \
-    'git update-index TT'
+test_expect_success 'change in branch A (edit)' '
+    git update-index TT
+'
 
 mkdir DF
 echo Branch A makes a file at DF/DF, creating a directory DF. >DF/DF
-test_expect_success \
-    'change in branch A (change file to directory)' \
-    'git update-index --add DF/DF'
+test_expect_success 'change in branch A (change file to directory)' '
+    git update-index --add DF/DF
+'
 
-test_expect_success \
-    'recording branch A tree' \
-    'tree_A=$(git write-tree)'
+test_expect_success 'recording branch A tree' '
+    tree_A=$(git write-tree)
+'
 
 ################################################################
 # Branch B
@@ -94,65 +94,65 @@  test_expect_success \
 
 rm -rf [NDMASLT][NDMASLT] Z DF
 mkdir Z
-test_expect_success \
-    'reading original tree and checking out' \
-    'git read-tree $tree_O &&
-     git checkout-index -a'
+test_expect_success 'reading original tree and checking out' '
+    git read-tree $tree_O &&
+    git checkout-index -a
+'
 
 to_remove=$(echo ?D Z/?D)
 rm -f $to_remove
-test_expect_success \
-    'change in branch B (removal)' \
-    "git update-index --remove $to_remove"
+test_expect_success 'change in branch B (removal)' '
+    git update-index --remove $to_remove
+'
 
 for p in ?M Z/?M
 do
     echo This is modified $p in the branch B. >$p
-    test_expect_success \
-	'change in branch B (modification)' \
-	"git update-index $p"
+    test_expect_success 'change in branch B (modification)' '
+	    git update-index $p
+    '
 done
 
 for p in NA AA Z/NA Z/AA
 do
     echo This is added $p in the branch B. >$p
-    test_expect_success \
-	'change in branch B (addition)' \
-	"git update-index --add $p"
+    test_expect_success 'change in branch B (addition)' '
+	    git update-index --add $p
+    '
 done
 echo This is SS from the modified tree. >SS
 echo This is LL from the modified tree. >LL
-test_expect_success \
-    'change in branch B (addition and modification)' \
-    'git update-index --add LL &&
-     git update-index SS'
+test_expect_success 'change in branch B (addition and modification)' '
+    git update-index --add LL &&
+    git update-index SS
+'
 mv TT TT-
 sed -e '/Branch B/s/word/WORD/g' <TT- >TT
 rm -f TT-
-test_expect_success \
-    'change in branch B (modification)' \
-    'git update-index TT'
+test_expect_success 'change in branch B (modification)' '
+    git update-index TT
+'
 
 echo Branch B makes a file at DF. >DF
-test_expect_success \
-    'change in branch B (addition of a file to conflict with directory)' \
-    'git update-index --add DF'
-
-test_expect_success \
-    'recording branch B tree' \
-    'tree_B=$(git write-tree)'
-
-test_expect_success \
-    'keep contents of 3 trees for easy access' \
-    'rm -f .git/index &&
-     git read-tree $tree_O &&
-     mkdir .orig-O &&
-     git checkout-index --prefix=.orig-O/ -f -q -a &&
-     rm -f .git/index &&
-     git read-tree $tree_A &&
-     mkdir .orig-A &&
-     git checkout-index --prefix=.orig-A/ -f -q -a &&
-     rm -f .git/index &&
-     git read-tree $tree_B &&
-     mkdir .orig-B &&
-     git checkout-index --prefix=.orig-B/ -f -q -a'
+test_expect_success 'change in branch B (addition of a file to conflict with directory)' '
+    git update-index --add DF
+'
+
+test_expect_success 'recording branch B tree' '
+    tree_B=$(git write-tree)
+'
+
+test_expect_success 'keep contents of 3 trees for easy access' '
+    rm -f .git/index &&
+    git read-tree $tree_O &&
+    mkdir .orig-O &&
+    git checkout-index --prefix=.orig-O/ -f -q -a &&
+    rm -f .git/index &&
+    git read-tree $tree_A &&
+    mkdir .orig-A &&
+    git checkout-index --prefix=.orig-A/ -f -q -a &&
+    rm -f .git/index &&
+    git read-tree $tree_B &&
+    mkdir .orig-B &&
+    git checkout-index --prefix=.orig-B/ -f -q -a
+'