From: Junio C Hamano <gitster@pobox.com>
To: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Cc: git@vger.kernel.org, Jeff King <peff@peff.net>
Subject: Re: [PATCH v2 0/6] add missing __attribute__((format))
Date: Tue, 13 Jul 2021 15:29:23 -0700 [thread overview]
Message-ID: <xmqqfswh26gs.fsf@gitster.g> (raw)
In-Reply-To: <cover-0.6-0000000000-20210713T080411Z-avarab@gmail.com> (=?utf-8?B?IsOGdmFyCUFybmZqw7Zyw7A=?= Bjarmason"'s message of "Tue, 13 Jul 2021 10:05:15 +0200")
Ævar Arnfjörð Bjarmason <avarab@gmail.com> writes:
> v2: Let's drop the whole bending over backwards to do mostly/entirely
> useless strftime() checking. That's gone, I added a patch at the end
> with a comment for strbuf_addftime() to say why it's not there, and
> also split up the advise_if_enabled() change into its own commit.
OK.
> I also removed the other cases of adding attribute checking to
> compat/*. I can't easily test those, and I don't know if there's
> potential bad interactions with git-compat-util.h.
Sensible.
> 3: bc3fee3b7a ! 3: e2e039f481 *.c static functions: add missing __attribute__((format))
> @@ commit-graph.c: int write_commit_graph(struct object_directory *odb,
> {
> va_list ap;
>
> - ## compat/mingw.c ##
> -@@ compat/mingw.c: static int read_yes_no_answer(void)
> - return -1;
> - }
> -
> -+__attribute__((format (printf, 1, 2)))
> - static int ask_yes_no_if_possible(const char *format, ...)
> - {
> - char question[4096];
> -
> - ## compat/winansi.c ##
> -@@ compat/winansi.c: static void winansi_exit(void)
> - CloseHandle(hthread);
> - }
> -
> -+__attribute__((format (printf, 1, 2)))
> - static void die_lasterr(const char *fmt, ...)
> - {
> - va_list params;
> -
> ## contrib/credential/osxkeychain/git-credential-osxkeychain.c ##
These refrain from touching some compat stuff, OK.
> 4: 3bf8637c16 ! 4: fd70d512b4 *.h: add a few missing __attribute__((format))
> @@ Metadata
> ## Commit message ##
> *.h: add a few missing __attribute__((format))
>
> - Add missing format attributes to those function that were missing
> - them.
> -
> - In the case of advice_enabled() this revealed a trivial issue
> - introduced in b3b18d16213 (advice: revamp advise API, 2020-03-02). We
> - treated the argv[1] as a format string, but did not intend to do
> - so. Let's use "%s" and pass argv[1] as an argument instead.
> -
> - For strbuf_addftime() let's add a strftime() format checker. Our
> - function understands the non-portable %z and %Z, see
> - c3fbf81a853 (strbuf: let strbuf_addftime handle %z and %Z itself,
> - 2017-06-15).
> -
> - That might be an issue in theory, but in practice we have existing
> - codepath that supplies a fixed string to strbuf_addftime(). We're
> - unlikely to run into the "%z" and "%Z" case at all, since it's used by
> - date.c and passed via e.g. "git log --date=<format>".
> -
> - In fact, we had no in-tree user of strbuf_addftime() with an inline
> - fixed format string at all. A subsequent commit will tweak an existing
> - one to use the format checking.
> + Add missing format attributes to API functions that take printf
> + arguments.
>
> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
OK. strftime() is gone.
> - ## advice.h ##
> -@@ advice.h: int advice_enabled(enum advice_type type);
> - /**
> - * Checks the visibility of the advice before printing.
> - */
> -+__attribute__((format (printf, 2, 3)))
> - void advise_if_enabled(enum advice_type type, const char *advice, ...);
This has become a separate one, because...?
OK, the addition to advise_if_enabled() reveals an existing iffy
caller, so you chose to fix it and to annotate the function at the
same time in a single commit at step [5/6]. Makes sense.
next prev parent reply other threads:[~2021-07-13 22:29 UTC|newest]
Thread overview: 33+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-10 8:47 [PATCH 0/6] add missing __attribute__((format)) Ævar Arnfjörð Bjarmason
2021-07-10 8:47 ` [PATCH 1/6] *.c static functions: don't forward-declare __attribute__ Ævar Arnfjörð Bjarmason
2021-07-10 8:47 ` [PATCH 2/6] sequencer.c: move static function to avoid forward decl Ævar Arnfjörð Bjarmason
2021-07-10 8:47 ` [PATCH 3/6] *.c static functions: add missing __attribute__((format)) Ævar Arnfjörð Bjarmason
2021-07-10 8:47 ` [PATCH 4/6] *.h: add a few " Ævar Arnfjörð Bjarmason
2021-07-11 23:05 ` Ævar Arnfjörð Bjarmason
2021-07-12 20:09 ` Jeff King
2021-07-10 8:47 ` [PATCH 5/6] bugreport.c: tweak cmd_bugreport() to use __attribute__((printf)) Ævar Arnfjörð Bjarmason
2021-07-12 19:39 ` Junio C Hamano
2021-07-10 8:47 ` [PATCH 6/6] git-compat-util.h: add __attribute__((printf)) to git_*printf* Ævar Arnfjörð Bjarmason
2021-07-12 20:13 ` Jeff King
2021-07-12 20:26 ` Randall S. Becker
2021-07-12 21:45 ` Jeff King
2021-07-12 21:58 ` Randall S. Becker
2021-07-12 20:14 ` [PATCH 0/6] add missing __attribute__((format)) Jeff King
2021-07-13 8:05 ` [PATCH v2 " Ævar Arnfjörð Bjarmason
2021-07-13 8:05 ` [PATCH v2 1/6] *.c static functions: don't forward-declare __attribute__ Ævar Arnfjörð Bjarmason
2021-07-13 8:05 ` [PATCH v2 2/6] sequencer.c: move static function to avoid forward decl Ævar Arnfjörð Bjarmason
2021-07-13 8:05 ` [PATCH v2 3/6] *.c static functions: add missing __attribute__((format)) Ævar Arnfjörð Bjarmason
2021-07-13 8:05 ` [PATCH v2 4/6] *.h: add a few " Ævar Arnfjörð Bjarmason
2021-07-13 8:05 ` [PATCH v2 5/6] advice.h: add missing __attribute__((format)) & fix usage Ævar Arnfjörð Bjarmason
2021-07-13 8:05 ` [PATCH v2 6/6] strbuf.h: add a comment about "missing" strftime() checking Ævar Arnfjörð Bjarmason
2021-07-13 21:15 ` Jeff King
2021-07-13 21:17 ` [PATCH v2 0/6] add missing __attribute__((format)) Jeff King
2021-07-13 22:29 ` Junio C Hamano [this message]
2021-07-13 23:05 ` Ævar Arnfjörð Bjarmason
2021-07-14 0:15 ` [PATCH v3 0/5] " Ævar Arnfjörð Bjarmason
2021-07-14 0:15 ` [PATCH v3 1/5] *.c static functions: don't forward-declare __attribute__ Ævar Arnfjörð Bjarmason
2021-07-14 0:15 ` [PATCH v3 2/5] sequencer.c: move static function to avoid forward decl Ævar Arnfjörð Bjarmason
2021-07-14 0:15 ` [PATCH v3 3/5] *.c static functions: add missing __attribute__((format)) Ævar Arnfjörð Bjarmason
2021-07-14 0:15 ` [PATCH v3 4/5] *.h: add a few " Ævar Arnfjörð Bjarmason
2021-07-14 0:15 ` [PATCH v3 5/5] advice.h: add missing __attribute__((format)) & fix usage Ævar Arnfjörð Bjarmason
2021-07-14 16:07 ` [PATCH v3 0/5] add missing __attribute__((format)) Junio C Hamano
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=xmqqfswh26gs.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=peff@peff.net \
/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).