From: Jeff King <peff@peff.net>
To: Junio C Hamano <gitster@pobox.com>
Cc: "Elijah Newren" <newren@gmail.com>,
"Ævar Arnfjörð" <avarab@gmail.com>,
"Git Mailing List" <git@vger.kernel.org>,
danshu@microsoft.com, marc@marc-stevens.nl
Subject: Re: [PATCH 0/9] Add missing includes and forward declares
Date: Tue, 14 Aug 2018 21:38:25 -0400 [thread overview]
Message-ID: <20180815013825.GA12178@sigill.intra.peff.net> (raw)
In-Reply-To: <xmqqr2j25dlm.fsf@gitster-ct.c.googlers.com>
On Mon, Aug 13, 2018 at 11:24:37AM -0700, Junio C Hamano wrote:
> As things are slowly moving out of the so-far kitchen-sink "cache.h"
> into more specific subsystem headers (like object-store.h), we may
> actually want to tighten the "header that includes it first" part a
> bit in the future, so that 'git grep cache.h' would give us a more
> explicit and a better picture of what really depends on knowing what
> the lowest level plumbing API are built around.
Yeah, I agree that's a good long-term goal. I think "builtin.h" is
reasonable to remain as a magic header for builtins.
> > So I think the better test is a two-line .c file with:
> >
> > #include "git-compat-util.h"
> > #include $header_to_check
>
> But until that tightening happens, I do not actually mind the
> two-line .c file started with inclusion of cache.h instead of
> git-compat-util.h. That would limit the scope of this series
> further.
I can go either way on this. Using cache.h makes Elijah's current series
a bit more focused. But I think we'd eventually want to go there anyway.
I don't have a strong opinion on doing it now or later.
> > I wonder if there's an easy way to check. I guess adding '-Dint=foo' to
> > the command line, and then putting '#undef int' at the top of
> > git-compat-util would catch just about any code the compiler sees that
> > doesn't have git-compat-util included. :)
>
> ;-).
So much to my amazement, my off-the-cuff suggestion actually worked
pretty well. The only failures were xdiff (expected, since it does its
own system-header stuff, though IMHO we might think about changing that)
and the programs in t/helper. Here's a patch to address the latter (and
you can see now why I said the above thing about "builtin.h"):
-- >8 --
Subject: [PATCH] test-tool.h: include git-compat-util.h
The test-tool programs include "test-tool.h" as their first
include, which breaks our CodingGuideline of "the first
include must be git-compat-util.h or an equivalent". This
isn't actually a problem, as test-tool.h doesn't define
anything tricky, but we should probably follow our own rule.
Rather than change them all, let's instead make test-tool.h
one of those equivalents, just like we do for builtin.h
(which many of the actual git builtins include first).
Signed-off-by: Jeff King <peff@peff.net>
---
t/helper/test-tool.h | 2 ++
1 file changed, 2 insertions(+)
diff --git a/t/helper/test-tool.h b/t/helper/test-tool.h
index 80cbcf0857..75d7c782f0 100644
--- a/t/helper/test-tool.h
+++ b/t/helper/test-tool.h
@@ -1,6 +1,8 @@
#ifndef __TEST_TOOL_H__
#define __TEST_TOOL_H__
+#include "git-compat-util.h"
+
int cmd__chmtime(int argc, const char **argv);
int cmd__config(int argc, const char **argv);
int cmd__ctype(int argc, const char **argv);
--
2.18.0.1070.g4763fa3c01
next prev parent reply other threads:[~2018-08-15 1:38 UTC|newest]
Thread overview: 49+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-08-11 4:32 [PATCH 0/9] Add missing includes and forward declares Elijah Newren
2018-08-11 4:32 ` [PATCH 1/9] " Elijah Newren
2018-08-11 17:43 ` Jeff King
2018-08-11 4:32 ` [PATCH 2/9] alloc: make allocate_alloc_state and clear_alloc_state more consistent Elijah Newren
2018-08-11 4:32 ` [PATCH 3/9] Move definition of enum branch_track from cache.h to branch.h Elijah Newren
2018-08-11 4:32 ` [PATCH 4/9] urlmatch.h: fix include guard Elijah Newren
2018-08-11 4:32 ` [PATCH 5/9] compat/precompose_utf8.h: use more common include guard style Elijah Newren
2018-08-11 4:32 ` [PATCH 6/9] ewah/ewok.h: add missing include Elijah Newren
2018-08-11 4:32 ` [PATCH 7/9] sha1dc/sha1.h: " Elijah Newren
2018-08-11 4:32 ` [PATCH 8/9] xdiff/xdiff.h: " Elijah Newren
2018-08-11 4:32 ` [PATCH 9/9] Add missing includes and forward declares Elijah Newren
2018-08-11 8:30 ` [PATCH 0/9] " Ævar Arnfjörð Bjarmason
2018-08-11 8:59 ` Elijah Newren
2018-08-11 17:34 ` Jeff King
2018-08-13 18:24 ` Junio C Hamano
2018-08-14 6:42 ` Elijah Newren
2018-08-15 5:45 ` Junio C Hamano
2018-08-15 5:57 ` Elijah Newren
2018-08-15 15:43 ` Junio C Hamano
2018-08-15 15:55 ` Elijah Newren
2018-08-15 16:11 ` Junio C Hamano
2018-08-15 1:38 ` Jeff King [this message]
2018-08-15 4:55 ` Jonathan Nieder
2018-08-15 4:57 ` Jonathan Nieder
2018-08-11 20:50 ` [PATCHv2 0/6] " Elijah Newren
2018-08-11 20:50 ` [PATCHv2 1/6] " Elijah Newren
2018-08-11 20:50 ` [PATCHv2 2/6] alloc: make allocate_alloc_state and clear_alloc_state more consistent Elijah Newren
2018-08-11 20:50 ` [PATCHv2 3/6] Move definition of enum branch_track from cache.h to branch.h Elijah Newren
2018-08-11 21:32 ` Ramsay Jones
2018-08-11 20:50 ` [PATCHv2 4/6] urlmatch.h: fix include guard Elijah Newren
2018-08-11 20:50 ` [PATCHv2 5/6] compat/precompose_utf8.h: use more common include guard style Elijah Newren
2018-08-11 20:50 ` [PATCHv2 6/6] Add missing includes and forward declares Elijah Newren
2018-08-13 17:17 ` [PATCHv3 0/6] " Elijah Newren
2018-08-13 17:17 ` [PATCHv3 1/6] " Elijah Newren
2018-08-15 5:10 ` Jonathan Nieder
2018-08-15 5:50 ` Elijah Newren
2018-08-15 6:13 ` Jonathan Nieder
2018-08-15 6:51 ` Elijah Newren
2018-08-15 15:26 ` Elijah Newren
2018-08-13 17:17 ` [PATCHv3 2/6] alloc: make allocate_alloc_state and clear_alloc_state more consistent Elijah Newren
2018-08-15 5:18 ` Jonathan Nieder
2018-08-13 17:17 ` [PATCHv3 3/6] Move definition of enum branch_track from cache.h to branch.h Elijah Newren
2018-08-15 5:22 ` Jonathan Nieder
2018-08-13 17:17 ` [PATCHv3 4/6] urlmatch.h: fix include guard Elijah Newren
2018-08-15 5:25 ` Jonathan Nieder
2018-08-13 17:17 ` [PATCHv3 5/6] compat/precompose_utf8.h: use more common include guard style Elijah Newren
2018-08-15 5:28 ` Jonathan Nieder
2018-08-13 17:17 ` [PATCHv3 6/6] Add missing includes and forward declares Elijah Newren
2018-08-15 5:31 ` Jonathan Nieder
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180815013825.GA12178@sigill.intra.peff.net \
--to=peff@peff.net \
--cc=avarab@gmail.com \
--cc=danshu@microsoft.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=marc@marc-stevens.nl \
--cc=newren@gmail.com \
/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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).