From cf6fa4edf006e9790a53bf5c5a8e89ef03625dee Mon Sep 17 00:00:00 2001
From: Marian Buschsieweke <marian.buschsieweke@posteo.net>
Date: Sun, 14 Apr 2024 14:26:05 +0200
Subject: [PATCH] tree wide: add `IWYU pragma: export` where needed

We occasionally have some public `foo.h` header that includes a private
`foo_arch.h` header. Users are expected to include the `foo.h` header
and not the `foo_arch.h`. However, clangd will claim that the `#include`
of `foo.h` is unused if only functions / macros/ types / ... from
`foor_arch.h` is used and nothing from `foo.h`.

This adds the `IWYU pragma: export` comment to the include of
`foo_arch.h` in `foo.h`, so that clangd treats functions / macros /
types provided by `foo_arch.h` as if they were instead provided by
`foo.h`, which fixes the false positives.
---
 core/include/thread.h            | 2 +-
 core/lib/include/irq.h           | 2 +-
 drivers/include/periph/gpio_ll.h | 2 +-
 drivers/include/periph/timer.h   | 2 +-
 sys/include/architecture.h       | 2 +-
 sys/include/atomic_utils.h       | 2 +-
 sys/include/flash_utils.h        | 2 +-
 7 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/core/include/thread.h b/core/include/thread.h
index 8e0dcca5a7..023626c986 100644
--- a/core/include/thread.h
+++ b/core/include/thread.h
@@ -129,7 +129,7 @@
 #include "thread_flags.h"
 #endif
 
-#include "thread_arch.h"
+#include "thread_arch.h" /* IWYU pragma: export */
 
 #ifdef __cplusplus
 extern "C" {
diff --git a/core/lib/include/irq.h b/core/lib/include/irq.h
index 3505eb03fd..64c6c09787 100644
--- a/core/lib/include/irq.h
+++ b/core/lib/include/irq.h
@@ -91,7 +91,7 @@ MAYBE_INLINE bool irq_is_enabled(void);
 MAYBE_INLINE bool irq_is_in(void);
 
 #else
-#include "irq_arch.h"
+#include "irq_arch.h" /* IWYU pragma: export */
 #endif /* IRQ_API_INLINED */
 
 #ifdef __cplusplus
diff --git a/drivers/include/periph/gpio_ll.h b/drivers/include/periph/gpio_ll.h
index ec2c708dac..365c31b400 100644
--- a/drivers/include/periph/gpio_ll.h
+++ b/drivers/include/periph/gpio_ll.h
@@ -866,7 +866,7 @@ static inline void gpio_ll_switch_dir_input(gpio_port_t port, uword_t inputs)
 
 /* the hardware specific implementation relies on the types such as gpio_port_t
  * to be provided */
-#include "gpio_ll_arch.h"
+#include "gpio_ll_arch.h" /* IWYU pragma: export */
 
 #endif /* PERIPH_GPIO_LL_H */
 /** @} */
diff --git a/drivers/include/periph/timer.h b/drivers/include/periph/timer.h
index e9321c1963..1253cd347a 100644
--- a/drivers/include/periph/timer.h
+++ b/drivers/include/periph/timer.h
@@ -326,7 +326,7 @@ bool timer_poll_channel(tim_t dev, int channel);
 #endif
 
 #if defined(MODULE_PERIPH_TIMER_POLL)
-#include "timer_arch.h"
+#include "timer_arch.h" /* IWYU pragma: export */
 #endif
 
 #ifdef __cplusplus
diff --git a/sys/include/architecture.h b/sys/include/architecture.h
index 4d192ad54a..37c36a7a32 100644
--- a/sys/include/architecture.h
+++ b/sys/include/architecture.h
@@ -28,7 +28,7 @@
 #include <inttypes.h>
 #include <limits.h>
 
-#include "architecture_arch.h"
+#include "architecture_arch.h" /* IWYU pragma: export */
 
 #ifdef __cplusplus
 extern "C" {
diff --git a/sys/include/atomic_utils.h b/sys/include/atomic_utils.h
index 32da0ea69d..1b3ff41439 100644
--- a/sys/include/atomic_utils.h
+++ b/sys/include/atomic_utils.h
@@ -142,7 +142,7 @@
 #include "macros/utils.h"
 #include "sched.h"
 
-#include "atomic_utils_arch.h"
+#include "atomic_utils_arch.h" /* IWYU pragma: export */
 
 #ifdef __cplusplus
 extern "C" {
diff --git a/sys/include/flash_utils.h b/sys/include/flash_utils.h
index 44f54b8991..e5bdd64428 100644
--- a/sys/include/flash_utils.h
+++ b/sys/include/flash_utils.h
@@ -54,7 +54,7 @@
 #include "kernel_defines.h"
 
 #if IS_ACTIVE(HAS_FLASH_UTILS_ARCH)
-#include "flash_utils_arch.h"
+#include "flash_utils_arch.h" /* IWYU pragma: export */
 #endif
 
 #ifdef __cplusplus