sequencer: handle multi-byte comment characters when writing todo list

peff · gitster · commit 7eb35e07c6f5 · 2024-03-12T13:28:10.000-07:00
We already match multi-byte comment characters in parse_insn_line(),
thanks to the previous commit, yielding a TODO_COMMENT entry. But in
todo_list_to_strbuf(), we may call command_to_char() to convert that
back into something we can output.

We can't just return comment_line_char anymore, since it may require
multiple bytes. Instead, we'll return "0" for this case, which is the
same thing we'd return for a command which does not have a single-letter
abbreviation (e.g., "revert" or "noop"). There is only a single caller
of command_to_char(), and upon seeing "0" it falls back to outputting
the full name via command_to_string(). So we can handle TODO_COMMENT
there, returning the full string.

Note that there are many other callers of command_to_string(), which
will now behave differently if they pass TODO_COMMENT. But we would not
expect that to happen; prior to this commit, the function just calls
die() in this case. And looking at those callers, that makes sense;
e.g., do_pick_commit() will only be called when servicing a pick
command, and should never be called for a comment in the first place.

Signed-off-by: Jeff King &lt;peff@peff.net&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git a/sequencer.c b/sequencer.c
@@ -1779,14 +1779,16 @@ static const char *command_to_string(const enum todo_command command)
 {
 	if (command < TODO_COMMENT)
 		return todo_command_info[command].str;
+	if (command == TODO_COMMENT)
+		return comment_line_str;
 	die(_("unknown command: %d"), command);
 }
 
 static char command_to_char(const enum todo_command command)
 {
 	if (command < TODO_COMMENT)
 		return todo_command_info[command].c;
-	return comment_line_char;
+	return 0;
 }
 
 static int is_noop(const enum todo_command command)

Original file line number	Diff line number	Diff line change
`@@ -1779,14 +1779,16 @@ static const char *command_to_string(const enum todo_command command)`
`1779`	`1779`	`{`
`1780`	`1780`	`if (command < TODO_COMMENT)`
`1781`	`1781`	`return todo_command_info[command].str;`
	`1782`	`+ if (command == TODO_COMMENT)`
	`1783`	`+ return comment_line_str;`
`1782`	`1784`	`die(_("unknown command: %d"), command);`
`1783`	`1785`	`}`
`1784`	`1786`
`1785`	`1787`	`static char command_to_char(const enum todo_command command)`
`1786`	`1788`	`{`
`1787`	`1789`	`if (command < TODO_COMMENT)`
`1788`	`1790`	`return todo_command_info[command].c;`
`1789`		`- return comment_line_char;`
	`1791`	`+ return 0;`
`1790`	`1792`	`}`
`1791`	`1793`
`1792`	`1794`	`static int is_noop(const enum todo_command command)`