diff mbox series

[v2,02/17] treewide: remove unnecessary git-compat-util.h includes in headers

Message ID e1c2b55ac67391ea05c44703dc6f3c8bd27066c3.1677197377.git.gitgitgadget@gmail.com (mailing list archive)
State Superseded
Commit f332121e75d3aa2b0ce7efd120ac3ede19e9a733
Headers show
Series Header cleanups | expand

Commit Message

Elijah Newren Feb. 24, 2023, 12:09 a.m. UTC 
From: Elijah Newren <newren@gmail.com>

For sanity, we should probably do one of the following:

(a) make C and header files both depend upon everything they need
(b) consistently exclude git-compat-util.h from headers and require it
    be the first include in C files

Currently, we have some of the headers following (a) and others
following (b), which makes things messy.  In the past I was pushed
towards (b), as per [1] and [2].  Further, during this series I
discovered that this mixture empirically will mean that we end up with C
files that do not directly include git-compat-util.h, and do include
headers that don't include git-compat-util.h, with the result that we
likely have headers included before an indirect inclusion of
git-compat-util.h.  Since git-compat-util.h has tricky platform-specific
stuff that is meant to be included before everything else, this state of
affairs is risky and may lead to things breaking in subtle ways (and
only on some platforms) as per [1] and [2].

Since including git-compat-util.h in existing header files makes it
harder for us to catch C files that are missing that include, let's
switch to (b) to make the enforcement of this rule easier.  Remove the
inclusion of git-compat-util.h from header files other than the ones
that have been approved as alternate first includes.

[1] https://lore.kernel.org/git/20180811173406.GA9119@sigill.intra.peff.net/
[2] https://lore.kernel.org/git/20180811174301.GA9287@sigill.intra.peff.net/

Signed-off-by: Elijah Newren <newren@gmail.com>
---
 advice.h           | 2 --
 cbtree.h           | 2 --
 chunk-format.h     | 1 -
 commit-graph.h     | 1 -
 commit-slab-impl.h | 2 --
 hash.h             | 1 -
 pack-mtimes.h      | 2 --
 pkt-line.h         | 1 -
 repository.h       | 1 -
 sub-process.h      | 1 -
 trace.h            | 1 -
 11 files changed, 15 deletions(-)
diff mbox series

Patch

diff --git a/advice.h b/advice.h
index 07e0f76833e..3e1b48bf68d 100644
--- a/advice.h
+++ b/advice.h
@@ -1,8 +1,6 @@ 
 #ifndef ADVICE_H
 #define ADVICE_H
 
-#include "git-compat-util.h"
-
 struct string_list;
 
 /*
diff --git a/cbtree.h b/cbtree.h
index 0be14fb7ee4..43193abdda2 100644
--- a/cbtree.h
+++ b/cbtree.h
@@ -14,8 +14,6 @@ 
 #ifndef CBTREE_H
 #define CBTREE_H
 
-#include "git-compat-util.h"
-
 struct cb_node;
 struct cb_node {
 	struct cb_node *child[2];
diff --git a/chunk-format.h b/chunk-format.h
index 7885aa08487..025c38f938e 100644
--- a/chunk-format.h
+++ b/chunk-format.h
@@ -1,7 +1,6 @@ 
 #ifndef CHUNK_FORMAT_H
 #define CHUNK_FORMAT_H
 
-#include "git-compat-util.h"
 #include "hash.h"
 
 struct hashfile;
diff --git a/commit-graph.h b/commit-graph.h
index 37faee6b66d..bb88bec7aa3 100644
--- a/commit-graph.h
+++ b/commit-graph.h
@@ -1,7 +1,6 @@ 
 #ifndef COMMIT_GRAPH_H
 #define COMMIT_GRAPH_H
 
-#include "git-compat-util.h"
 #include "object-store.h"
 #include "oidset.h"
 
diff --git a/commit-slab-impl.h b/commit-slab-impl.h
index 557738df271..4a414ee905d 100644
--- a/commit-slab-impl.h
+++ b/commit-slab-impl.h
@@ -1,8 +1,6 @@ 
 #ifndef COMMIT_SLAB_IMPL_H
 #define COMMIT_SLAB_IMPL_H
 
-#include "git-compat-util.h"
-
 #define implement_static_commit_slab(slabname, elemtype) \
 	implement_commit_slab(slabname, elemtype, MAYBE_UNUSED static)
 
diff --git a/hash.h b/hash.h
index 36b64165fc9..351afc2ce3b 100644
--- a/hash.h
+++ b/hash.h
@@ -1,7 +1,6 @@ 
 #ifndef HASH_H
 #define HASH_H
 
-#include "git-compat-util.h"
 #include "repository.h"
 
 #if defined(SHA1_APPLE)
diff --git a/pack-mtimes.h b/pack-mtimes.h
index cc957b3e852..107327cec0b 100644
--- a/pack-mtimes.h
+++ b/pack-mtimes.h
@@ -1,8 +1,6 @@ 
 #ifndef PACK_MTIMES_H
 #define PACK_MTIMES_H
 
-#include "git-compat-util.h"
-
 #define MTIMES_SIGNATURE 0x4d544d45 /* "MTME" */
 #define MTIMES_VERSION 1
 
diff --git a/pkt-line.h b/pkt-line.h
index 79c538b99e4..8e9846f3151 100644
--- a/pkt-line.h
+++ b/pkt-line.h
@@ -1,7 +1,6 @@ 
 #ifndef PKTLINE_H
 #define PKTLINE_H
 
-#include "git-compat-util.h"
 #include "strbuf.h"
 #include "sideband.h"
 
diff --git a/repository.h b/repository.h
index e8c67ffe165..15a8afc5fb5 100644
--- a/repository.h
+++ b/repository.h
@@ -1,7 +1,6 @@ 
 #ifndef REPOSITORY_H
 #define REPOSITORY_H
 
-#include "git-compat-util.h"
 #include "path.h"
 
 struct config_set;
diff --git a/sub-process.h b/sub-process.h
index e85f21fa1a7..6a61638a8ac 100644
--- a/sub-process.h
+++ b/sub-process.h
@@ -1,7 +1,6 @@ 
 #ifndef SUBPROCESS_H
 #define SUBPROCESS_H
 
-#include "git-compat-util.h"
 #include "hashmap.h"
 #include "run-command.h"
 
diff --git a/trace.h b/trace.h
index 4e771f86ac2..1a75824b15e 100644
--- a/trace.h
+++ b/trace.h
@@ -1,7 +1,6 @@ 
 #ifndef TRACE_H
 #define TRACE_H
 
-#include "git-compat-util.h"
 #include "strbuf.h"
 
 /**