git-commit: fix cut_line behavior with CRLF

Commit Message

Robert Boyd III April 11, 2023, 10:55 p.m. UTC

From: Robert Boyd III <[e-mail]>

On Windows with certain editor (mis)configurations, the cut_line that is
used when commit.verbose is turned on doesn't work correctly because
COMMIT_EDITMSG is rewritten with Windows line endings. This used to
happen on old versions of VSCode, but I can't seem to reproduce it
anymore without explicitly setting the line-endings to Windows. Even so,
I think it would be sensible to fix this for good, even in the face of
bad editor behavior.

This patch moves the \n ending out of the detection string constant, so
that regardless of the line endings, the cut_line is detected correctly.

Signed-off-by: Robert Boyd III <[e-mail]>
---
    git-commit: fix cut_line behavior with CRLF

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1513%2Frob-3%2Fmaint-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1513/rob-3/maint-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1513

 wt-status.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)


base-commit: 73876f4861cd3d187a4682290ab75c9dccadbc56

Comments

Junio C Hamano April 11, 2023, 11:10 p.m. UTC | #1

"Robert Boyd III via GitGitGadget" <[e-mail]> writes:

> From: Robert Boyd III <[e-mail]>
>
> On Windows with certain editor (mis)configurations, the cut_line that is
> used when commit.verbose is turned on doesn't work correctly because
> COMMIT_EDITMSG is rewritten with Windows line endings. This used to
> happen on old versions of VSCode, but I can't seem to reproduce it
> anymore without explicitly setting the line-endings to Windows. Even so,
> I think it would be sensible to fix this for good, even in the face of
> bad editor behavior.
>
> This patch moves the \n ending out of the detection string constant, so
> that regardless of the line endings, the cut_line is detected correctly.

The problem description does make sense.

Removing the hardcoded LF from the constant is a good idea, because
we would want to allow CRLF after the cut_line[] constant on Windows
while we usually expect LF there.  The code that inserts cut_line[]
into the output wants to have the LF at the end of the input string,
and your patch correctly compensates for the loss of LF, so that is
good, too.

But wt_status_locate_end() should be taught about our expectation
that cut_line[] we seek is supposed to be followed by either LF or
CRLF.  Otherwise we would mistake any random line that begins with
the cut_line[] constant, followed by arbitrary garbage that is not
end of line.

Thanks.

>  wt-status.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/wt-status.c b/wt-status.c
> index 3162241a570..85904362fe5 100644
> --- a/wt-status.c
> +++ b/wt-status.c
> @@ -24,7 +24,7 @@
>  #define UF_DELAY_WARNING_IN_MS (2 * 1000)
>  
>  static const char cut_line[] =
> -"------------------------ >8 ------------------------\n";
> +"------------------------ >8 ------------------------";
>  
>  static char default_wt_status_colors[][COLOR_MAXLEN] = {
>  	GIT_COLOR_NORMAL, /* WT_STATUS_HEADER */
> @@ -1090,7 +1090,7 @@ void wt_status_append_cut_line(struct strbuf *buf)
>  {
>  	const char *explanation = _("Do not modify or remove the line above.\nEverything below it will be ignored.");
>  
> -	strbuf_commented_addf(buf, "%s", cut_line);
> +	strbuf_commented_addf(buf, "%s\n", cut_line);
>  	strbuf_add_commented_lines(buf, explanation, strlen(explanation));
>  }
>  
>
> base-commit: 73876f4861cd3d187a4682290ab75c9dccadbc56

Patch

diff --git a/wt-status.c b/wt-status.c
index 3162241a570..85904362fe5 100644
--- a/wt-status.c
+++ b/wt-status.c
@@ -24,7 +24,7 @@ 
 #define UF_DELAY_WARNING_IN_MS (2 * 1000)
 
 static const char cut_line[] =
-"------------------------ >8 ------------------------\n";
+"------------------------ >8 ------------------------";
 
 static char default_wt_status_colors[][COLOR_MAXLEN] = {
 	GIT_COLOR_NORMAL, /* WT_STATUS_HEADER */
@@ -1090,7 +1090,7 @@  void wt_status_append_cut_line(struct strbuf *buf)
 {
 	const char *explanation = _("Do not modify or remove the line above.\nEverything below it will be ignored.");
 
-	strbuf_commented_addf(buf, "%s", cut_line);
+	strbuf_commented_addf(buf, "%s\n", cut_line);
 	strbuf_add_commented_lines(buf, explanation, strlen(explanation));
 }