[PATCH 7/8] write_file: add format attribute

From: Jeff King <peff@peff.net>
Date: Jul 8, 2016, 09:12 UTC
Message-ID: <20160708091241.GG10152@sigill.intra.peff.net>
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