2008-07-25 18:28:41 +02:00
|
|
|
#include "cache.h"
|
|
|
|
|
#include "strbuf.h"
|
|
|
|
|
#include "run-command.h"
|
2012-11-30 23:41:26 +01:00
|
|
|
#include "sigchain.h"
|
2008-07-25 18:28:41 +02:00
|
|
|
|
2009-10-31 02:44:41 +01:00
|
|
|
#ifndef DEFAULT_EDITOR
|
|
|
|
|
#define DEFAULT_EDITOR "vi"
|
|
|
|
|
#endif
|
|
|
|
|
|
2009-11-12 01:01:27 +01:00
|
|
|
const char *git_editor(void)
|
2008-07-25 18:28:41 +02:00
|
|
|
{
|
Do not use VISUAL editor on dumb terminals
Refuse to use $VISUAL and fall back to $EDITOR if TERM is unset
or set to "dumb". Traditionally, VISUAL is set to a screen
editor and EDITOR to a line-based editor, which should be more
useful in that situation.
vim, for example, is happy to assume a terminal supports ANSI
sequences even if TERM is dumb (e.g., when running from a text
editor like Acme). git already refuses to fall back to vi on a
dumb terminal if GIT_EDITOR, core.editor, VISUAL, and EDITOR are
unset, but without this patch, that check is suppressed by
VISUAL=vi.
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2009-11-12 00:56:07 +01:00
|
|
|
const char *editor = getenv("GIT_EDITOR");
|
|
|
|
|
const char *terminal = getenv("TERM");
|
|
|
|
|
int terminal_is_dumb = !terminal || !strcmp(terminal, "dumb");
|
2008-07-25 18:28:41 +02:00
|
|
|
|
|
|
|
|
if (!editor && editor_program)
|
|
|
|
|
editor = editor_program;
|
Do not use VISUAL editor on dumb terminals
Refuse to use $VISUAL and fall back to $EDITOR if TERM is unset
or set to "dumb". Traditionally, VISUAL is set to a screen
editor and EDITOR to a line-based editor, which should be more
useful in that situation.
vim, for example, is happy to assume a terminal supports ANSI
sequences even if TERM is dumb (e.g., when running from a text
editor like Acme). git already refuses to fall back to vi on a
dumb terminal if GIT_EDITOR, core.editor, VISUAL, and EDITOR are
unset, but without this patch, that check is suppressed by
VISUAL=vi.
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2009-11-12 00:56:07 +01:00
|
|
|
if (!editor && !terminal_is_dumb)
|
2008-07-25 18:28:41 +02:00
|
|
|
editor = getenv("VISUAL");
|
|
|
|
|
if (!editor)
|
|
|
|
|
editor = getenv("EDITOR");
|
|
|
|
|
|
Do not use VISUAL editor on dumb terminals
Refuse to use $VISUAL and fall back to $EDITOR if TERM is unset
or set to "dumb". Traditionally, VISUAL is set to a screen
editor and EDITOR to a line-based editor, which should be more
useful in that situation.
vim, for example, is happy to assume a terminal supports ANSI
sequences even if TERM is dumb (e.g., when running from a text
editor like Acme). git already refuses to fall back to vi on a
dumb terminal if GIT_EDITOR, core.editor, VISUAL, and EDITOR are
unset, but without this patch, that check is suppressed by
VISUAL=vi.
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2009-11-12 00:56:07 +01:00
|
|
|
if (!editor && terminal_is_dumb)
|
2009-11-12 01:01:27 +01:00
|
|
|
return NULL;
|
2008-07-25 18:28:41 +02:00
|
|
|
|
|
|
|
|
if (!editor)
|
2009-10-31 02:44:41 +01:00
|
|
|
editor = DEFAULT_EDITOR;
|
2008-07-25 18:28:41 +02:00
|
|
|
|
2009-11-12 01:01:27 +01:00
|
|
|
return editor;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
int launch_editor(const char *path, struct strbuf *buffer, const char *const *env)
|
|
|
|
|
{
|
|
|
|
|
const char *editor = git_editor();
|
|
|
|
|
|
|
|
|
|
if (!editor)
|
|
|
|
|
return error("Terminal is dumb, but EDITOR unset");
|
|
|
|
|
|
2008-07-25 18:28:41 +02:00
|
|
|
if (strcmp(editor, ":")) {
|
2013-07-28 18:59:42 +02:00
|
|
|
const char *args[] = { editor, real_path(path), NULL };
|
2014-08-19 21:09:35 +02:00
|
|
|
struct child_process p = CHILD_PROCESS_INIT;
|
launch_editor: propagate signals from editor to git
We block SIGINT and SIGQUIT while the editor runs so that
git is not killed accidentally by a stray "^C" meant for the
editor or its subprocesses. This works because most editors
ignore SIGINT.
However, some editor wrappers, like emacsclient, expect to
die due to ^C. We detect the signal death in the editor and
properly exit, but not before writing a useless error
message to stderr. Instead, let's notice when the editor was
killed by a terminal signal and just raise the signal on
ourselves. This skips the message and looks to our parent
like we received SIGINT ourselves.
The end effect is that if the user's editor ignores SIGINT,
we will, too. And if it does not, then we will behave as if
we did not ignore it. That should make all users happy.
Note that in the off chance that another part of git has
ignored SIGINT while calling launch_editor, we will still
properly detect and propagate the failed return code from
the editor (i.e., the worst case is that we generate the
useless error, not fail to notice the editor's death).
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-11-30 23:41:50 +01:00
|
|
|
int ret, sig;
|
2008-07-25 18:28:41 +02:00
|
|
|
|
2012-11-30 23:41:04 +01:00
|
|
|
p.argv = args;
|
|
|
|
|
p.env = env;
|
|
|
|
|
p.use_shell = 1;
|
|
|
|
|
if (start_command(&p) < 0)
|
|
|
|
|
return error("unable to start editor '%s'", editor);
|
|
|
|
|
|
2012-11-30 23:41:26 +01:00
|
|
|
sigchain_push(SIGINT, SIG_IGN);
|
|
|
|
|
sigchain_push(SIGQUIT, SIG_IGN);
|
|
|
|
|
ret = finish_command(&p);
|
run-command: encode signal death as a positive integer
When a sub-command dies due to a signal, we encode the
signal number into the numeric exit status as "signal -
128". This is easy to identify (versus a regular positive
error code), and when cast to an unsigned integer (e.g., by
feeding it to exit), matches what a POSIX shell would return
when reporting a signal death in $? or through its own exit
code.
So we have a negative value inside the code, but once it
passes across an exit() barrier, it looks positive (and any
code we receive from a sub-shell will have the positive
form). E.g., death by SIGPIPE (signal 13) will look like
-115 to us in inside git, but will end up as 141 when we
call exit() with it. And a program killed by SIGPIPE but run
via the shell will come to us with an exit code of 141.
Unfortunately, this means that when the "use_shell" option
is set, we need to be on the lookout for _both_ forms. We
might or might not have actually invoked the shell (because
we optimize out some useless shell calls). If we didn't invoke
the shell, we will will see the sub-process's signal death
directly, and run-command converts it into a negative value.
But if we did invoke the shell, we will see the shell's
128+signal exit status. To be thorough, we would need to
check both, or cast the value to an unsigned char (after
checking that it is not -1, which is a magic error value).
Fortunately, most callsites do not care at all whether the
exit was from a code or from a signal; they merely check for
a non-zero status, and sometimes propagate the error via
exit(). But for the callers that do care, we can make life
slightly easier by just using the consistent positive form.
This actually fixes two minor bugs:
1. In launch_editor, we check whether the editor died from
SIGINT or SIGQUIT. But we checked only the negative
form, meaning that we would fail to notice a signal
death exit code which was propagated through the shell.
2. In handle_alias, we assume that a negative return value
from run_command means that errno tells us something
interesting (like a fork failure, or ENOENT).
Otherwise, we simply propagate the exit code. Negative
signal death codes confuse us, and we print a useless
"unable to run alias 'foo': Success" message. By
encoding signal deaths using the positive form, the
existing code just propagates it as it would a normal
non-zero exit code.
The downside is that callers of run_command can no longer
differentiate between a signal received directly by the
sub-process, and one propagated. However, no caller
currently cares, and since we already optimize out some
calls to the shell under the hood, that distinction is not
something that should be relied upon by callers.
Fix the same logic in t/test-terminal.perl for consistency [jc:
raised by Jonathan in the discussion].
Signed-off-by: Jeff King <peff@peff.net>
Acked-by: Johannes Sixt <j6t@kdbg.org>
Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-01-05 15:49:49 +01:00
|
|
|
sig = ret - 128;
|
2012-11-30 23:41:26 +01:00
|
|
|
sigchain_pop(SIGINT);
|
|
|
|
|
sigchain_pop(SIGQUIT);
|
launch_editor: propagate signals from editor to git
We block SIGINT and SIGQUIT while the editor runs so that
git is not killed accidentally by a stray "^C" meant for the
editor or its subprocesses. This works because most editors
ignore SIGINT.
However, some editor wrappers, like emacsclient, expect to
die due to ^C. We detect the signal death in the editor and
properly exit, but not before writing a useless error
message to stderr. Instead, let's notice when the editor was
killed by a terminal signal and just raise the signal on
ourselves. This skips the message and looks to our parent
like we received SIGINT ourselves.
The end effect is that if the user's editor ignores SIGINT,
we will, too. And if it does not, then we will behave as if
we did not ignore it. That should make all users happy.
Note that in the off chance that another part of git has
ignored SIGINT while calling launch_editor, we will still
properly detect and propagate the failed return code from
the editor (i.e., the worst case is that we generate the
useless error, not fail to notice the editor's death).
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-11-30 23:41:50 +01:00
|
|
|
if (sig == SIGINT || sig == SIGQUIT)
|
|
|
|
|
raise(sig);
|
2012-11-30 23:41:26 +01:00
|
|
|
if (ret)
|
2008-07-25 18:28:42 +02:00
|
|
|
return error("There was a problem with the editor '%s'.",
|
|
|
|
|
editor);
|
2008-07-25 18:28:41 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (!buffer)
|
2008-07-25 18:28:42 +02:00
|
|
|
return 0;
|
2008-07-25 18:28:41 +02:00
|
|
|
if (strbuf_read_file(buffer, path, 0) < 0)
|
2016-05-08 11:47:43 +02:00
|
|
|
return error_errno("could not read file '%s'", path);
|
2008-07-25 18:28:42 +02:00
|
|
|
return 0;
|
2008-07-25 18:28:41 +02:00
|
|
|
}
|