Skip to contentSkip to conversation

t0000: replace an instant of test -f with test_path_is_file functions.

PATCH In review Caleb Tillman 3 participants 3 messages Oct 18, 2020

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 t0000: replace an instant of test -f with test_path_is_file functions.

The test_path_is* functions provide debug-friendly messages upon failure.

--- Outrachy Microproject, revised submission

 t/t0000-basic.sh | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
t/t0000-basic.sh +1 -1
index 923281af93..eb99892a87 100755
@@ -1191,7 +1191,7 @@ test_expect_success 'writing this tree with --missing-ok' '
 test_expect_success 'git read-tree followed by write-tree should be idempotent' '
 	rm -f .git/index &&
 	git read-tree $tree &&
-	test -f .git/index &&
+	test_path_is_file .git/index &&
 	newtree=$(git write-tree) &&
 	test "$newtree" = "$tree"
 '
Signature · 1 line
2.25.1
#1 lore raw

Hi Caleb,

Quoted 1 line · Caleb Tillman

The test_path_is* functions provide debug-friendly messages upon failure.

The body looks fine to me. Your subject is getting a little long, however. Typical guidance would be somewhere around 50 (at least in my opinion, I thought we had something in Documentation/CodingGuidelines, but I couldn't find anything).

Maybe something instead like:

t0000: replace 'test -f' with helpers

or:

t0000: modernize test style

If you're looking for inspiration, you can use git log's -S flag to look for anything that mentions 'test_path_is_file' to see how similar patches have been written in the past. (When I was recommending alternatives, I ran "git log --oneline -Stest_path_is_file -- t").

Quoted 2 lines

--- Outrachy Microproject, revised submission

I think that you meant to put this "Outrachy ..." _below_ the triple-dash line. Incidentally, Git still applies this patch just fine, but it is easier for reviewers to pick it up if the "---" line is left alone.

t/t0000-basic.sh test_expect_success 'writing this tree with --missing-ok' ' · line 1194

Quoted 13 lines
 t/t0000-basic.sh | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
t/t0000-basic.sh +1 -1
index 923281af93..eb99892a87 100755
@@ -1191,7 +1191,7 @@ test_expect_success 'writing this tree with --missing-ok' '
 test_expect_success 'git read-tree followed by write-tree should be idempotent' '
 	rm -f .git/index &&
 	git read-tree $tree &&
-	test -f .git/index &&
+	test_path_is_file .git/index &&

This looks totally correct to me.

Thanks,
Taylor

#2 lore raw
Quoted 14 lines · Taylor Blau

Hi Caleb,

Quoted 1 line · Caleb Tillman

The test_path_is* functions provide debug-friendly messages upon failure.

The body looks fine to me. Your subject is getting a little long, however. Typical guidance would be somewhere around 50 (at least in my opinion, I thought we had something in Documentation/CodingGuidelines, but I couldn't find anything).

Maybe something instead like:

t0000: replace 'test -f' with helpers

Quoted 8 lines

or:

t0000: modernize test style

If you're looking for inspiration, you can use git log's -S flag to look for anything that mentions 'test_path_is_file' to see how similar patches have been written in the past. (When I was recommending alternatives, I ran "git log --oneline -Stest_path_is_file -- t").

Thanks for a great educational input.

Quoted 4 lines
Quoted 4 lines
t/t0000-basic.sh +0 -0
index 923281af93..eb99892a87 100755
Quoted 8 lines

t/t0000-basic.sh test_expect_success 'writing this tree with --missing-ok' ' · line 1194

Quoted 6 lines
t/t0000-basic.sh +1 -1
@@ -1191,7 +1191,7 @@ test_expect_success 'writing this tree with --missing-ok' '
 test_expect_success 'git read-tree followed by write-tree should be idempotent' '
 	rm -f .git/index &&
 	git read-tree $tree &&
-	test -f .git/index &&
+	test_path_is_file .git/index &&

This looks totally correct to me.

By nature of "microproject" exchange, it is almost trivial to get the patch text right after an exchange. The problems are typically so easy that there is only one way to write the code part correctly.

Polishing proposed log message is much harder ;-)

Thanks.