git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jeff King <peff@peff.net>
To: Russ Cox <rsc@golang.org>
Cc: git@vger.kernel.org
Subject: [PATCH] add: check return value of launch_editor
Date: Tue, 12 May 2015 21:21:58 -0400	[thread overview]
Message-ID: <20150513012158.GA3066@peff.net> (raw)
In-Reply-To: <CAA8EjDS9HePk6ZFa0kOy7GDa9_c_TsJ7uv7t+N9RL-3z=ZrQFQ@mail.gmail.com>

On Tue, May 12, 2015 at 08:31:26PM -0400, Russ Cox wrote:

> The root cause seems to be that builtin/add.c's edit_patch does not
> check the result of  the launch_editor call. It probably should.

Yes, definitely. Patch is below.

> The call to launch_editor in builtin/config.c should probably also be
> checked, although there it's not as big a deal, provided the editor
> did not modify the file; reapplying the same file should be a no-op.
> This is different from git add -e.

This one is trickier. Certainly we could propagate the return value and
say "hey, editing did not work". But we otherwise have no operation to
abort. This is because "git config --edit" does not actually take our
normal dot-lock, but rather edits the file in place.

IMHO this is questionable, as proper locking seems like half of the
purpose of "config --edit" (the other half being that you do not have to
type the location of the config file yourself). But I wonder if
switching it would make people unhappy, as it would probably break
editor rules to do syntax highlighting (e.g., if they are looking for
"*/.gitconfig" in the path).

-- >8 --
Subject: add: check return value of launch_editor

When running "add -e", if launching the editor fails, we do
not notice and continue as if the output is what the user
asked for. The likely case is that the editor did not touch
the contents at all, and we end up adding everything.

Reported-by: Russ Cox <rsc@golang.org>
Signed-off-by: Jeff King <peff@peff.net>
---
 builtin/add.c       | 3 ++-
 t/t3702-add-edit.sh | 7 +++++++
 2 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/builtin/add.c b/builtin/add.c
index 3390933..4bd98b7 100644
--- a/builtin/add.c
+++ b/builtin/add.c
@@ -208,7 +208,8 @@ static int edit_patch(int argc, const char **argv, const char *prefix)
 	if (run_diff_files(&rev, 0))
 		die(_("Could not write patch"));
 
-	launch_editor(file, NULL, NULL);
+	if (launch_editor(file, NULL, NULL))
+		die(_("editing patch failed"));
 
 	if (stat(file, &st))
 		die_errno(_("Could not stat '%s'"), file);
diff --git a/t/t3702-add-edit.sh b/t/t3702-add-edit.sh
index 4ee47cc..3cb74ca 100755
--- a/t/t3702-add-edit.sh
+++ b/t/t3702-add-edit.sh
@@ -118,4 +118,11 @@ test_expect_success 'add -e' '
 
 '
 
+test_expect_success 'add -e notices editor failure' '
+	git reset --hard &&
+	echo change >>file &&
+	test_must_fail env GIT_EDITOR=false git add -e &&
+	test_expect_code 1 git diff --exit-code
+'
+
 test_done
-- 
2.4.0.192.g5f8138b

  reply	other threads:[~2015-05-13  1:22 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-05-13  0:31 'EDITOR=false git add -e' adds to index Russ Cox
2015-05-13  1:21 ` Jeff King [this message]
2015-05-13  8:12   ` [PATCH] add: check return value of launch_editor Johannes Schindelin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20150513012158.GA3066@peff.net \
    --to=peff@peff.net \
    --cc=git@vger.kernel.org \
    --cc=rsc@golang.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).