From: Jeff King <peff@peff.net>
To: Johannes Schindelin <Johannes.Schindelin@gmx.de>
Cc: "René Scharfe" <l.s.r@web.de>, "Git List" <git@vger.kernel.org>,
"Junio C Hamano" <gitster@pobox.com>
Subject: [PATCH 7/8] write_file: add format attribute
Date: Fri, 8 Jul 2016 05:12:42 -0400 [thread overview]
Message-ID: <20160708091241.GG10152@sigill.intra.peff.net> (raw)
In-Reply-To: <20160708090400.GA26594@sigill.intra.peff.net>
This gives us compile-time checking of our format strings,
which is a good thing.
I had also hoped it would help with confusing write_file()
and write_file_buf(), since the former's "..." can make it
match the signature of the latter. But given that the buffer
for write_file_buf() is generally not a string literal, the
compiler won't complain unless -Wformat-nonliteral is on,
and that creates a ton of false positives elsewhere in the
code base.
While we're there, let's also give the function a docstring,
which it never had.
Signed-off-by: Jeff King <peff@peff.net>
---
cache.h | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/cache.h b/cache.h
index 9d6ad4f..c6a282c 100644
--- a/cache.h
+++ b/cache.h
@@ -1751,6 +1751,14 @@ static inline ssize_t write_str_in_full(int fd, const char *str)
*/
extern void write_file_buf(const char *path, const char *buf, size_t len);
+/**
+ * Like write_file_buf(), but format the contents into a buffer first.
+ * Additionally, write_file() will append a newline if one is not already
+ * present, making it convenient to write text files:
+ *
+ * write_file(path, "counter: %d", ctr);
+ */
+__attribute__((format (printf, 2, 3)))
extern void write_file(const char *path, const char *fmt, ...);
/* pager.c */
--
2.9.0.393.g704e522
next prev parent reply other threads:[~2016-07-08 9:13 UTC|newest]
Thread overview: 27+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-07-07 20:02 [PATCH] am: ignore return value of write_file() René Scharfe
2016-07-07 20:31 ` Jeff King
2016-07-08 6:37 ` Johannes Schindelin
2016-07-08 6:56 ` Jeff King
2016-07-08 9:04 ` [PATCH 0/8] write_file cleanups Jeff King
2016-07-08 9:06 ` [PATCH 1/8] config: fix bogus fd check when setting up default config Jeff King
2016-07-08 9:08 ` [PATCH 2/8] am: ignore return value of write_file() Jeff King
2016-07-08 9:08 ` [PATCH 3/8] branch: use non-gentle write_file for branch description Jeff King
2016-07-08 9:09 ` [PATCH 4/8] write_file: drop "gently" form Jeff King
2016-07-08 9:10 ` [PATCH 5/8] write_file: use xopen Jeff King
2016-07-08 9:12 ` [PATCH 6/8] write_file: add pointer+len variant Jeff King
2016-07-08 9:12 ` Jeff King [this message]
2016-07-08 9:25 ` [PATCH 7/8] write_file: add format attribute Jeff King
2016-07-08 9:25 ` [PATCH 1/2] walker: let walker_say take arbitrary formats Jeff King
2016-07-08 9:25 ` [PATCH 2/2] avoid using sha1_to_hex output as printf format Jeff King
2016-07-08 10:35 ` Jeff King
2016-07-08 17:02 ` Junio C Hamano
2016-07-08 17:09 ` Junio C Hamano
2016-07-08 21:41 ` Jeff King
2016-07-08 9:12 ` [PATCH 8/8] use write_file_buf where applicable Jeff King
2016-07-08 9:16 ` [PATCH 9/8] branch: use write_file_buf instead of write_file Jeff King
2016-07-08 18:44 ` [PATCH 0/8] write_file cleanups René Scharfe
2016-07-09 14:24 ` [PATCH] am: ignore return value of write_file() Johannes Schindelin
2016-07-10 10:53 ` Johannes Schindelin
2016-07-08 6:33 ` Johannes Schindelin
2016-07-08 18:44 ` René Scharfe
2016-07-08 21:51 ` 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=20160708091241.GG10152@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 \
/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).