format-patch: notice failure to open cover letter for writing
PATCH 1/1 format-patch: notice failure to open cover letter for writing
The make_cover_letter() function is supposed to open a new file for writing, and let the caller write into it via FILE *rev->diffopt.file but because the function does not return anything, the caller does not bother checking the return value.
Make sure it dies, instead of keep going with a NULL output filestream and relying on it to cause a crash.
--- builtin/log.c | 2 +- t/t4014-format-patch.sh | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-)
builtin/log.c +1 -1
@@ -1047,7 +1047,7 @@ static void make_cover_letter(struct rev_info *rev, int use_stdout,if (!use_stdout &&open_next_file (NULL , rev->numbered_files ?NULL :"cover-letter" , rev, quiet)) -return ; +die (_ ("Failed to create cover-letter file" ));log_write_email_headers (rev, head, &pp.after_subject, &need_8bit_cte,0 );
t/t4014-format-patch.sh +6 -0
@@ -589,6 +589,12 @@ test_expect_success 'excessive subject' ' ls patches/0004-This-is-an-excessively-long-subject-line-for-a-messa.patch ' +test_expect_success 'failure to write cover-letter aborts gracefully' ' + test_when_finished "rmdir 0000-cover-letter.patch" && + mkdir 0000-cover-letter.patch && + test_must_fail git format-patch --no-renames --cover-letter -1 +' + test_expect_success 'cover-letter inherits diff options' ' git mv file foo && git commit -m foo &&
Quoted 7 lines · Junio C Hamano
The
make_cover_letter()function is supposed to open a new file for writing, and let the caller write into it via FILE*rev->diffopt.filebut because the function does not return anything, the caller does not bother checking the return value.Make sure it dies, instead of keep going with a NULL output filestream and relying on it to cause a crash.
Definitely makes sense.
builtin/log.c static void make_cover_letter(struct rev_info *rev, int use_stdout, · line 1050
Quoted 10 lines
builtin/log.c +1
-1@@ -1047,7 +1047,7 @@ static void make_cover_letter(struct rev_info *rev, int use_stdout,if (!use_stdout &&open_next_file (NULL , rev->numbered_files ?NULL :"cover-letter" , rev, quiet)) -return ; +die (_ ("Failed to create cover-letter file" ));
I wondered if we should be showing errno here, but it looks like open_next_file() will give us a more specific error (including errno if applicable).
I'd suggest s/F/f/ in the message to match our usual style, though I see this code has a lot of capitalized errors already. :)
builtin/log.c static void make_cover_letter(struct rev_info *rev, int use_stdout,
Quoted 5 lines
builtin/log.c +5
-0+test_expect_success 'failure to write cover-letter aborts gracefully' ' + test_when_finished"rmdir 0000-cover-letter.patch" && + mkdir 0000-cover-letter.patch && + test_must_fail git format-patch --no-renames --cover-letter -1 +'
Cute test. :)
-Peff
Quoted 6 lines · Jeff King
Quoted 6 lines
builtin/log.c +0
-0@@ -1047,7 +1047,7 @@ static void make_cover_letter(struct rev_info *rev, int use_stdout,
Quoted 7 lines
builtin/log.c static void make_cover_letter(struct rev_info *rev, int use_stdout, · line 1050
Quoted 4 lines
builtin/log.c +1
-1if (!use_stdout &&open_next_file (NULL , rev->numbered_files ?NULL :"cover-letter" , rev, quiet)) -return ; +die (_ ("Failed to create cover-letter file" ));I'd suggest s/F/f/ in the message to match our usual style, though I see this code has a lot of capitalized errors already. :)
Thanks! The lowercase wins over uppercase [1] 1517 to 327. Unfortunately it's a tie in this file. But I think it's still good that new messages stick to lowercase.
[1] counting error/warn/die only with
git grep 'die[_a-z]*(_("[A-Z]\|error[_a-z]*(_("[A-Z]\|warning[_a-z]*(_("[A-Z]' -- \*.c
Signature · 1 line
Duy
Quoted 2 lines · Jeff King
I'd suggest s/F/f/ in the message to match our usual style, though I see this code has a lot of capitalized errors already. :)
Yup, I'd prepare a prelim clean-up before this step.
Quoted 7 lines
t/t4014-format-patch.sh test_expect_success 'excessive subject' ' · line 596
Quoted 5 lines
t/t4014-format-patch.sh +5
-0+test_expect_success 'failure to write cover-letter aborts gracefully' ' + test_when_finished "rmdir 0000-cover-letter.patch" && + mkdir 0000-cover-letter.patch && + test_must_fail git format-patch --no-renames --cover-letter -1 +'Cute test. :)
Those who can find this "cute" would probably know, but for others, this is a trick to test codepath for "cannot create a file" error without requiring SANITY prerequisite.