[PATCH] clang-tidy: Suppress silly misc-include-cleaner warnings

[PATCH] clang-tidy: Suppress silly misc-include-cleaner warnings

[David Gibson]

clang-tidy from LLVM 17.0.3 (which is in Fedora 39) includes a new
"misc-include-cleaner" warning that tries to make sure that headers
*directly* provide the things that are used in the .c file.  That sounds
great in theory but is in practice unusable:

Quite a few common things in the standard library are ultimately provided
by OS-specific system headers, but for portability should be accessed via
closer-to-standardised library headers.  This will warn constantly about
such cases: e.g. it will want you to include <linux/limits.h> instead of
<limits.h> to get PATH_MAX.

So, suppress this warning globally in the Makefile.

Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
---
 Makefile | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/Makefile b/Makefile
index 743c123..ff21459 100644
--- a/Makefile
+++ b/Makefile
@@ -250,6 +250,12 @@ docs: README.md
 # - bugprone-assignment-in-if-condition
 #	Dubious value over the compiler's built-in warning.  Would
 #	increase verbosity.
+#
+# - misc-include-cleaner
+#	Wants to include headers which *directly* provide the things
+#	we use.  That sounds nice, but means it will often want a OS
+#	specific header instead of a mostly standard one, such as
+#	<linux/limits.h> instead of <limits.h>.
 
 clang-tidy: $(SRCS) $(HEADERS)
 	clang-tidy -checks=*,-modernize-*,\
@@ -275,7 +281,8 @@ clang-tidy: $(SRCS) $(HEADERS)
 	-readability-function-cognitive-complexity,\
 	-altera-struct-pack-align,\
 	-concurrency-mt-unsafe,\
-	-readability-identifier-length \
+	-readability-identifier-length,\
+	-misc-include-cleaner \
 	-config='{CheckOptions: [{key: bugprone-suspicious-string-compare.WarnOnImplicitComparison, value: "false"}]}' \
 	--warnings-as-errors=* $(SRCS) -- $(filter-out -pie,$(FLAGS) $(CFLAGS) $(CPPFLAGS)) -DCLANG_TIDY_58992
 
-- 
@@ -250,6 +250,12 @@ docs: README.md
 # - bugprone-assignment-in-if-condition
 #	Dubious value over the compiler's built-in warning.  Would
 #	increase verbosity.
+#
+# - misc-include-cleaner
+#	Wants to include headers which *directly* provide the things
+#	we use.  That sounds nice, but means it will often want a OS
+#	specific header instead of a mostly standard one, such as
+#	<linux/limits.h> instead of <limits.h>.
 
 clang-tidy: $(SRCS) $(HEADERS)
 	clang-tidy -checks=*,-modernize-*,\
@@ -275,7 +281,8 @@ clang-tidy: $(SRCS) $(HEADERS)
 	-readability-function-cognitive-complexity,\
 	-altera-struct-pack-align,\
 	-concurrency-mt-unsafe,\
-	-readability-identifier-length \
+	-readability-identifier-length,\
+	-misc-include-cleaner \
 	-config='{CheckOptions: [{key: bugprone-suspicious-string-compare.WarnOnImplicitComparison, value: "false"}]}' \
 	--warnings-as-errors=* $(SRCS) -- $(filter-out -pie,$(FLAGS) $(CFLAGS) $(CPPFLAGS)) -DCLANG_TIDY_58992
 
-- 
2.41.0

Re: [PATCH] clang-tidy: Suppress silly misc-include-cleaner warnings

[Stefano Brivio]

On Wed, 15 Nov 2023 13:59:45 +1100
David Gibson <david@gibson.dropbear.id.au> wrote:

> clang-tidy from LLVM 17.0.3 (which is in Fedora 39) includes a new
> "misc-include-cleaner" warning that tries to make sure that headers
> *directly* provide the things that are used in the .c file.  That sounds
> great in theory but is in practice unusable:
> 
> Quite a few common things in the standard library are ultimately provided
> by OS-specific system headers, but for portability should be accessed via
> closer-to-standardised library headers.  This will warn constantly about
> such cases: e.g. it will want you to include <linux/limits.h> instead of
> <limits.h> to get PATH_MAX.
> 
> So, suppress this warning globally in the Makefile.
> 
> Signed-off-by: David Gibson <david@gibson.dropbear.id.au>

Applied.

-- 
Stefano