treewide: ensure one of the appropriate headers is sourced first
commit8bff5ca030d314d613e1ab58f07b27914d6dfd33
authorElijah Newren <newren@gmail.com>
Fri, 24 Feb 2023 00:09:20 +0000 (24 00:09 +0000)
committerJunio C Hamano <gitster@pobox.com>
Fri, 24 Feb 2023 01:25:28 +0000 (23 17:25 -0800)
tree41f3b9d47ebad2794acc9e9e2174ce9bf843ac80
parent06dd2baa8da4a73421b959ec026a43711b9d77f9
treewide: ensure one of the appropriate headers is sourced first

We had several C files ignoring the rule to include one of the
appropriate headers first; fix that.

While at it, the rule in Documentation/CodingGuidelines about which
header to include has also fallen out of sync, so update the wording to
mention other allowed headers.

Unfortunately, C files in reftable/ don't actually follow the previous
or updated rule.  If you follow the #include chain in its C files,
reftable/system.h _tends_ to be first (i.e. record.c first includes
record.h, which first includes basics.h, which first includees
system.h), but not always (e.g. publicbasics.c includes another header
first that does not include system.h).  However, I'm going to punt on
making actual changes to the C files in reftable/ since I do not want to
risk bringing it out-of-sync with any version being used externally.

Signed-off-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
14 files changed:
Documentation/CodingGuidelines
cbtree.c
compat/fsmonitor/fsm-ipc-win32.c
compat/fsmonitor/fsm-settings-darwin.c
diff-merges.c
fmt-merge-msg.c
oidtree.c
oss-fuzz/fuzz-commit-graph.c
oss-fuzz/fuzz-pack-headers.c
oss-fuzz/fuzz-pack-idx.c
prune-packed.c
rebase.c
refs/debug.c
sub-process.c