From: Jeff King <peff@peff.net>
To: Junio C Hamano <gitster@pobox.com>
Cc: "Simon Ruderich" <simon@ruderich.org>,
"Johannes Schindelin" <Johannes.Schindelin@gmx.de>,
"René Scharfe" <l.s.r@web.de>, "Git List" <git@vger.kernel.org>,
"Ralf Thielow" <ralf.thielow@gmail.com>
Subject: Re: [PATCH 1/2] sequencer: factor out rewrite_file()
Date: Fri, 3 Nov 2017 15:13:10 -0400 [thread overview]
Message-ID: <20171103191309.sth4zjokgcupvk2e@sigill.intra.peff.net> (raw)
In-Reply-To: <xmqqpo8zpjdj.fsf@gitster.mtv.corp.google.com>
On Fri, Nov 03, 2017 at 10:44:08PM +0900, Junio C Hamano wrote:
> Simon Ruderich <simon@ruderich.org> writes:
>
> > I tried looking into this by adding a new write_file_buf_gently()
> > (or maybe renaming write_file_buf to write_file_buf_or_die) and
> > using it from write_file_buf() but I don't know the proper way to
> > handle the error-case in write_file_buf(). Just calling
> > die("write_file_buf") feels ugly, as the real error was already
> > printed on screen by error_errno() and I didn't find any function
> > to just exit without writing a message (which still respects
> > die_routine). Suggestions welcome.
>
> How about *not* printing the error at the place where you notice the
> error, and instead return an error code to the caller to be noticed
> which dies with an error message?
That ends up giving less-specific errors. It might be an OK tradeoff
here.
I think we've been gravitating towards error strbufs, which would make
it something like:
diff --git a/wrapper.c b/wrapper.c
index 61aba0b5c1..08eb5d1cb8 100644
--- a/wrapper.c
+++ b/wrapper.c
@@ -649,13 +649,34 @@ int xsnprintf(char *dst, size_t max, const char *fmt, ...)
return len;
}
+int write_file_buf_gently(const char *path, const char *buf, size_t len,
+ struct strbuf *err)
+{
+ int fd = open(path, O_WRONLY | O_CREAT | O_TRUNC, 0666);
+ if (fd < 0) {
+ strbuf_addf(err, _("could not open '%s' for writing: %s"),
+ path, strerror(errno));
+ return -1;
+ }
+ if (write_in_full(fd, buf, len) < 0) {
+ strbuf_addf(err, _("could not write to %s: %s"),
+ path, strerror(errno));
+ close(fd);
+ return -1;
+ }
+ if (close(fd)) {
+ strbuf_addf(err, _("could not close %s: %s"),
+ path, strerror(errno));
+ return -1;
+ }
+ return 0;
+}
+
void write_file_buf(const char *path, const char *buf, size_t len)
{
- int fd = xopen(path, O_WRONLY | O_CREAT | O_TRUNC, 0666);
- if (write_in_full(fd, buf, len) < 0)
- die_errno(_("could not write to %s"), path);
- if (close(fd))
- die_errno(_("could not close %s"), path);
+ struct strbuf err = STRBUF_INIT;
+ if (write_file_buf_gently(path, buf, len, &err) < 0)
+ die("%s", err.buf);
}
void write_file(const char *path, const char *fmt, ...)
I'm not excited that the amount of error-handling code is now double the
amount of code that actually does something useful. Maybe this function
simply isn't large/complex enough to merit flexible error handling, and
we should simply go with René's original near-duplicate.
OTOH, if we went all-in on flexible error handling contexts, you could
imagine this function becoming:
void write_file_buf(const char *path, const char *buf, size_t len,
struct error_context *err)
{
int fd = xopen(path, err, O_WRONLY | O_CREAT | O_TRUNC, 0666);
if (fd < 0)
return -1;
if (write_in_full(fd, buf, len, err) < 0)
return -1;
if (xclose(fd, err) < 0)
return -1;
return 0;
}
Kind of gross, in that we're adding a layer on top of all system calls.
But if used consistently, it makes error-reporting a lot more pleasant,
and makes all of our "whoops, we forgot to save errno" bugs go away.
-Peff
next prev parent reply other threads:[~2017-11-03 19:13 UTC|newest]
Thread overview: 35+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-10-31 9:54 [PATCH 1/2] sequencer: factor out rewrite_file() René Scharfe
2017-10-31 9:58 ` [PATCH 2/2] sequencer: use O_TRUNC to truncate files René Scharfe
2017-10-31 16:34 ` Kevin Daudt
2017-11-01 15:34 ` Johannes Schindelin
2017-10-31 16:33 ` [PATCH 1/2] sequencer: factor out rewrite_file() Kevin Daudt
2017-11-01 6:06 ` Kevin Daudt
2017-11-01 11:10 ` Simon Ruderich
2017-11-01 13:00 ` René Scharfe
2017-11-01 14:44 ` [PATCH 1/2] wrapper.c: consistently quote filenames in error messages Simon Ruderich
2017-11-02 4:40 ` Junio C Hamano
2017-11-02 5:16 ` Junio C Hamano
2017-11-02 10:20 ` Simon Ruderich
2017-11-03 1:47 ` Junio C Hamano
2017-11-01 14:45 ` [PATCH 2/2] sequencer.c: check return value of close() in rewrite_file() Simon Ruderich
2017-11-01 17:09 ` René Scharfe
2017-11-01 15:33 ` [PATCH 1/2] sequencer: factor out rewrite_file() Johannes Schindelin
2017-11-01 19:47 ` Jeff King
2017-11-01 21:46 ` Johannes Schindelin
2017-11-01 22:16 ` Jeff King
2017-11-03 10:32 ` Simon Ruderich
2017-11-03 13:44 ` Junio C Hamano
2017-11-03 19:13 ` Jeff King [this message]
2017-11-04 9:05 ` René Scharfe
2017-11-04 9:35 ` Jeff King
2017-11-04 18:36 ` Simon Ruderich
2017-11-05 2:07 ` Jeff King
2017-11-06 16:13 ` Improved error handling (Was: [PATCH 1/2] sequencer: factor out rewrite_file()) Simon Ruderich
2017-11-16 10:36 ` Simon Ruderich
2017-11-17 22:33 ` Jeff King
2017-11-18 9:01 ` Johannes Sixt
2017-12-24 14:54 ` Jeff King
2017-12-24 15:45 ` Randall S. Becker
2017-12-25 10:28 ` Johannes Sixt
2017-11-03 14:46 ` [PATCH 1/2] sequencer: factor out rewrite_file() Johannes Schindelin
2017-11-03 18:57 ` Jeff King
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=20171103191309.sth4zjokgcupvk2e@sigill.intra.peff.net \
--to=peff@peff.net \
--cc=Johannes.Schindelin@gmx.de \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=l.s.r@web.de \
--cc=ralf.thielow@gmail.com \
--cc=simon@ruderich.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).