[PATCH v2] send-email: clarify missing subject error

From: Harald Nordgren <[email protected]>

Clarify that a message file is missing a 'Subject:' line.

Terminate the error with a newline so Perl does not append its internal
source location.

Signed-off-by: Harald Nordgren <[email protected]>
---
    send-email: clarify missing subject error
    
    Explain the required Subject: prefix when a message file has no subject.
    Terminate the error with a newline so Perl does not append its internal
    source location.
    
    Changes in v2:
    
     * Remove the incorrect claim that Subject: must be the first line.
       Report the missing header directly as No 'Subject:' line in '<file>'.

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-2375%2FHaraldNordgren%2Ffix%2Fsend-email-subject-error-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-2375/HaraldNordgren/fix/send-email-subject-error-v2
Pull-Request: https://github.com/git/git/pull/2375

Range-diff vs v1:

 1:  fe4171b0dc ! 1:  7002c5d5f1 send-email: clarify missing subject error
     @@ Metadata
       ## Commit message ##
          send-email: clarify missing subject error
      
     -    Explain the required Subject: prefix when a message file has no subject.
     +    Clarify that a message file is missing a 'Subject:' line.
     +
          Terminate the error with a newline so Perl does not append its internal
          source location.
      
     @@ git-send-email.perl: sub get_patch_subject {
       	}
       	close $fh;
      -	die sprintf(__("No subject line in %s?"), $fn);
     -+	die sprintf(__("No subject line in %s. " .
     -+		"The first line must start with \"Subject: \"\n"), $fn);
     ++	die sprintf(__("No 'Subject:' line in '%s'\n"), $fn);
       }
       
       if ($compose) {
     @@ t/t9001-send-email.sh: test_expect_success $PREREQ 'detects ambiguous reference/
      +		[email protected] \
      +		no-subject.patch 2>actual &&
      +	cat >expect <<-\EOF &&
     -+	No subject line in no-subject.patch. The first line must start with "Subject: "
     ++	No '\''Subject:'\'' line in '\''no-subject.patch'\''
      +	EOF
      +	test_cmp expect actual
      +'


 git-send-email.perl   |  2 +-
 t/t9001-send-email.sh | 15 +++++++++++++++
 2 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/git-send-email.perl b/git-send-email.perl
index bb8ddd1eef..2071cff6ae 100755
--- a/git-send-email.perl
+++ b/git-send-email.perl
@@ -863,7 +863,7 @@ sub get_patch_subject {
 		return "GIT: $1\n";
 	}
 	close $fh;
-	die sprintf(__("No subject line in %s?"), $fn);
+	die sprintf(__("No 'Subject:' line in '%s'\n"), $fn);
 }
 
 if ($compose) {
diff --git a/t/t9001-send-email.sh b/t/t9001-send-email.sh
index e9d814a34a..d1393ef197 100755
--- a/t/t9001-send-email.sh
+++ b/t/t9001-send-email.sh
@@ -1422,6 +1422,21 @@ test_expect_success $PREREQ 'detects ambiguous reference/file conflict' '
 	test_grep disambiguate errors
 '
 
+test_expect_success $PREREQ 'missing subject omits Perl location' '
+	cat >no-subject.patch <<-\EOF &&
+	This is the body.
+	EOF
+	test_must_fail git send-email \
+		--dry-run \
+		--from="Example <[email protected]>" \
+		[email protected] \
+		no-subject.patch 2>actual &&
+	cat >expect <<-\EOF &&
+	No '\''Subject:'\'' line in '\''no-subject.patch'\''
+	EOF
+	test_cmp expect actual
+'
+
 test_expect_success $PREREQ 'feed two files' '
 	rm -fr outdir &&
 	git format-patch -2 -o outdir &&

base-commit: 010afd3166ddc64c9863b1506f12cbcdda0d4ea1
-- 
gitgitgadget