From 83ad336c0858da48cbecdabbefbcd84a1461eb9b Mon Sep 17 00:00:00 2001 From: Simon Marchi Date: Mon, 11 Dec 2023 13:59:38 -0500 Subject: [PATCH] Add IWYU keep pragmas when including some compat headers When editing some on Linux, IWYU and clangd report some inclusions of `compat/endian.h`, for instance, as unused. This is because this header defines some macros only on systems that lack them, and Linux isn't one of them. These includes should not be removed, so add some pragmas to let tools (and even humans) know that they are important. Change-Id: Id2cba11a568567e6a75d094df3567b0847dac690 Signed-off-by: Simon Marchi Reviewed-on: https://review.lttng.org/c/babeltrace/+/11518 Tested-by: jenkins --- src/cpp-common/endian.hpp | 2 +- src/plugins/ctf/common/metadata/visitor-generate-ir.cpp | 2 +- src/plugins/ctf/fs-sink/fs-sink-stream.cpp | 2 +- src/plugins/ctf/fs-sink/translate-ctf-ir-to-tsdl.cpp | 2 +- src/plugins/ctf/fs-src/data-stream-file.cpp | 4 ++-- src/plugins/ctf/fs-src/lttng-index.hpp | 2 +- src/plugins/ctf/lttng-live/data-stream.cpp | 2 +- src/plugins/ctf/lttng-live/lttng-viewer-abi.hpp | 2 +- src/plugins/ctf/lttng-live/viewer-connection.cpp | 3 +-- 9 files changed, 10 insertions(+), 11 deletions(-) diff --git a/src/cpp-common/endian.hpp b/src/cpp-common/endian.hpp index 6d836ab4..a31e31ab 100644 --- a/src/cpp-common/endian.hpp +++ b/src/cpp-common/endian.hpp @@ -9,7 +9,7 @@ #include -#include "compat/endian.h" +#include "compat/endian.h" /* IWYU pragma: keep */ namespace bt2_common { diff --git a/src/plugins/ctf/common/metadata/visitor-generate-ir.cpp b/src/plugins/ctf/common/metadata/visitor-generate-ir.cpp index 50a8b541..c53c4d8a 100644 --- a/src/plugins/ctf/common/metadata/visitor-generate-ir.cpp +++ b/src/plugins/ctf/common/metadata/visitor-generate-ir.cpp @@ -27,7 +27,7 @@ #include "common/assert.h" #include "common/common.h" #include "common/uuid.h" -#include "compat/endian.h" +#include "compat/endian.h" /* IWYU pragma: keep */ #include "ast.hpp" #include "ctf-meta-visitors.hpp" diff --git a/src/plugins/ctf/fs-sink/fs-sink-stream.cpp b/src/plugins/ctf/fs-sink/fs-sink-stream.cpp index d56180b1..6611744b 100644 --- a/src/plugins/ctf/fs-sink/fs-sink-stream.cpp +++ b/src/plugins/ctf/fs-sink/fs-sink-stream.cpp @@ -15,7 +15,7 @@ #include "logging/comp-logging.h" #include "common/assert.h" -#include "compat/endian.h" +#include "compat/endian.h" /* IWYU pragma: keep */ #include "ctfser/ctfser.h" #include "fs-sink-ctf-meta.hpp" diff --git a/src/plugins/ctf/fs-sink/translate-ctf-ir-to-tsdl.cpp b/src/plugins/ctf/fs-sink/translate-ctf-ir-to-tsdl.cpp index a67796b8..85d8ccf9 100644 --- a/src/plugins/ctf/fs-sink/translate-ctf-ir-to-tsdl.cpp +++ b/src/plugins/ctf/fs-sink/translate-ctf-ir-to-tsdl.cpp @@ -10,7 +10,7 @@ #include #include "common/assert.h" -#include "compat/endian.h" +#include "compat/endian.h" /* IWYU pragma: keep */ #include "fs-sink-ctf-meta.hpp" #include "translate-ctf-ir-to-tsdl.hpp" diff --git a/src/plugins/ctf/fs-src/data-stream-file.cpp b/src/plugins/ctf/fs-src/data-stream-file.cpp index 698c0129..4a500221 100644 --- a/src/plugins/ctf/fs-src/data-stream-file.cpp +++ b/src/plugins/ctf/fs-src/data-stream-file.cpp @@ -20,8 +20,8 @@ #include "logging/comp-logging.h" #include "common/assert.h" -#include "compat/endian.h" -#include "compat/mman.h" +#include "compat/endian.h" /* IWYU pragma: keep */ +#include "compat/mman.h" /* IWYU pragma: keep */ #include "../common/msg-iter/msg-iter.hpp" #include "data-stream-file.hpp" diff --git a/src/plugins/ctf/fs-src/lttng-index.hpp b/src/plugins/ctf/fs-src/lttng-index.hpp index e07d87bc..36dc7cc9 100644 --- a/src/plugins/ctf/fs-src/lttng-index.hpp +++ b/src/plugins/ctf/fs-src/lttng-index.hpp @@ -11,7 +11,7 @@ #include -#include "compat/limits.h" +#include "compat/limits.h" /* IWYU pragma: keep */ #define CTF_INDEX_MAGIC 0xC1F1DCC1 #define CTF_INDEX_MAJOR 1 diff --git a/src/plugins/ctf/lttng-live/data-stream.cpp b/src/plugins/ctf/lttng-live/data-stream.cpp index 9ad1e9ef..4bba7ddb 100644 --- a/src/plugins/ctf/lttng-live/data-stream.cpp +++ b/src/plugins/ctf/lttng-live/data-stream.cpp @@ -21,7 +21,7 @@ #include "logging/comp-logging.h" #include "common/assert.h" -#include "compat/mman.h" +#include "compat/mman.h" /* IWYU pragma: keep */ #include "../common/msg-iter/msg-iter.hpp" #include "data-stream.hpp" diff --git a/src/plugins/ctf/lttng-live/lttng-viewer-abi.hpp b/src/plugins/ctf/lttng-live/lttng-viewer-abi.hpp index f8ae6a21..bf9abae4 100644 --- a/src/plugins/ctf/lttng-live/lttng-viewer-abi.hpp +++ b/src/plugins/ctf/lttng-live/lttng-viewer-abi.hpp @@ -11,7 +11,7 @@ #include -#include "compat/limits.h" +#include "compat/limits.h" /* IWYU pragma: keep */ #define LTTNG_VIEWER_PATH_MAX 4096 #define LTTNG_VIEWER_NAME_MAX 255 diff --git a/src/plugins/ctf/lttng-live/viewer-connection.cpp b/src/plugins/ctf/lttng-live/viewer-connection.cpp index 02c7e6ac..db5900af 100644 --- a/src/plugins/ctf/lttng-live/viewer-connection.cpp +++ b/src/plugins/ctf/lttng-live/viewer-connection.cpp @@ -17,8 +17,7 @@ #include "logging/comp-logging.h" #include "common/common.h" -#include "compat/endian.h" -#include "compat/socket.h" +#include "compat/endian.h" /* IWYU pragma: keep */ #include "data-stream.hpp" #include "lttng-live.hpp" -- 2.34.1