[RFC,2/2] editor: save and reset terminal after calling EDITOR

Commit Message

Carlo Marcelo Arenas Belón Oct. 2, 2021, 3:36 p.m. UTC

When EDITOR is invoked to modify a commit message, it will likely
change the terminal settings, and if it misbehaves will leave the
terminal output as shown in microsoft/terminal#9359.

Instead use the recently added {push,pop}_term() functions to save
the terminal configuration and recover safely.

[1] https://github.com/microsoft/terminal/issues/9359

Signed-off-by: Carlo Marcelo Arenas Belón <[e-mail]>
---
 editor.c | 4 ++++
 1 file changed, 4 insertions(+)

Patch

diff --git a/editor.c b/editor.c
index 6303ae0ab0..9095841642 100644
--- a/editor.c
+++ b/editor.c
@@ -3,6 +3,7 @@ 
 #include "strbuf.h"
 #include "run-command.h"
 #include "sigchain.h"
+#include "compat/terminal.h"
 
 #ifndef DEFAULT_EDITOR
 #define DEFAULT_EDITOR "vi"
@@ -83,7 +84,9 @@  static int launch_specified_editor(const char *editor, const char *path,
 		p.env = env;
 		p.use_shell = 1;
 		p.trace2_child_class = "editor";
+		push_term(1);
 		if (start_command(&p) < 0) {
+			pop_term();
 			strbuf_release(&realpath);
 			return error("unable to start editor '%s'", editor);
 		}
@@ -91,6 +94,7 @@  static int launch_specified_editor(const char *editor, const char *path,
 		sigchain_push(SIGINT, SIG_IGN);
 		sigchain_push(SIGQUIT, SIG_IGN);
 		ret = finish_command(&p);
+		pop_term();
 		strbuf_release(&realpath);
 		sig = ret - 128;
 		sigchain_pop(SIGINT);