git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 1/3] add missing "format" function attributes

From
Jeff King <peff@peff.net>
Date
Jul 10, 2013, 00:18 UTC
Message-ID
<20130710001840.GA19423@sigill.intra.peff.net>
In-Reply-To
<20130710001659.GA11643@sigill.intra.peff.net>

For most of our functions that take printf-like formats, we use gcc's __attribute__((format)) to get compiler warnings when the functions are misused. Let's give a few more functions the same protection.

In most cases, the annotations do not uncover any actual bugs; the only code change needed is that we passed a size_t to transfer_debug, which expected an int. Since we expect the passed-in value to be a relatively small buffer size (and cast a similar value to int directly below), we can just cast away the problem.

Signed-off-by: Jeff King <peff@peff.net>
---
 advice.h           | 1 +
 trace.c            | 1 +
 transport-helper.c | 3 ++-
 utf8.h             | 1 +
 4 files changed, 5 insertions(+), 1 deletion(-)
diff --git a/advice.h b/advice.h
index 93a7d11..08fbc8e 100644
--- a/advice.h
+++ b/advice.h
@@ -21,6 +21,7 @@ int git_default_advice_config(const char *var, const char *value);
 extern int advice_rm_hints;
 
 int git_default_advice_config(const char *var, const char *value);
+__attribute__((format (printf, 1, 2)))
 void advise(const char *advice, ...);
 int error_resolve_conflict(const char *me);
 extern void NORETURN die_resolve_conflict(const char *me);
diff --git a/trace.c b/trace.c
index 5ec0e3b..3d744d1 100644
--- a/trace.c
+++ b/trace.c
@@ -75,6 +75,7 @@ static void trace_vprintf(const char *key, const char *fmt, va_list ap)
 	strbuf_release(&buf);
 }
 
+__attribute__((format (printf, 2, 3)))
 static void trace_printf_key(const char *key, const char *fmt, ...)
 {
 	va_list ap;
diff --git a/transport-helper.c b/transport-helper.c
index db9bd18..45a35df 100644
--- a/transport-helper.c
+++ b/transport-helper.c
@@ -982,6 +982,7 @@ int transport_helper_init(struct transport *transport, const char *name)
 #define PBUFFERSIZE 8192
 
 /* Print bidirectional transfer loop debug message. */
+__attribute__((format (printf, 1, 2)))
 static void transfer_debug(const char *fmt, ...)
 {
 	va_list args;
@@ -1067,7 +1068,7 @@ static int udt_do_read(struct unidirectional_transfer *t)
 		return -1;
 	} else if (bytes == 0) {
 		transfer_debug("%s EOF (with %i bytes in buffer)",
-			t->src_name, t->bufuse);
+			t->src_name, (int)t->bufuse);
 		t->state = SSTATE_FLUSHING;
 	} else if (bytes > 0) {
 		t->bufuse += bytes;
diff --git a/utf8.h b/utf8.h
index 32a7bfb..65d0e42 100644
--- a/utf8.h
+++ b/utf8.h
@@ -10,6 +10,7 @@ int same_encoding(const char *, const char *);
 int is_utf8(const char *text);
 int is_encoding_utf8(const char *name);
 int same_encoding(const char *, const char *);
+__attribute__((format (printf, 2, 3)))
 int utf8_fprintf(FILE *, const char *, ...);
 
 void strbuf_add_wrapped_text(struct strbuf *buf,
-- 
1.8.3.rc3.24.gec82cb9
Previous: Jeff KingNext: Jeff King
Message 6 of 17 in “remote-http: use argv-array”
  1. remote-http: use argv-arrayJunio C Hamano, Jul 9, 2013
  2. Bert WesargJul 9, 2013
  3. Jeff KingJul 9, 2013
  4. Matt KraaiJul 9, 2013
  5. Jeff KingJul 10, 2013
  6. 1/3 add missing "format" function attributesJeff King, Jul 10, 2013
  7. 2/3 use "sentinel" function attribute for variadic listsJeff King, Jul 10, 2013
  8. 3/3 wt-status: use "format" function attribute for status_printfJeff King, Jul 10, 2013
  9. Junio C HamanoJul 10, 2013
  10. Jeff KingJul 10, 2013
  11. Junio C HamanoJul 10, 2013
  12. Jeff KingJul 10, 2013
  13. Junio C HamanoJul 10, 2013
  14. Jeff KingJul 10, 2013
  15. Junio C HamanoJul 10, 2013
  16. Junio C HamanoJul 12, 2013
  17. Jeff KingJul 12, 2013

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.