diff mbox series

[v3,9/9] tests/style: check qemu/osdep.h is NOT included in all .h/.c.inc files

Message ID 20220707163720.1421716-10-berrange@redhat.com
State New
Headers show
Series tests: introduce a tree-wide code style checking facility | expand

Commit Message

Daniel P. Berrangé July 7, 2022, 4:37 p.m. UTC
Since the qemu/osdep.h file must be included as the very first header
in all C source files, there is no reason to include it in .h or .c.in
files.

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
 tests/style.yml | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Eric Blake July 21, 2022, 7:16 p.m. UTC | #1
On Thu, Jul 07, 2022 at 05:37:20PM +0100, Daniel P. Berrangé wrote:
> Since the qemu/osdep.h file must be included as the very first header
> in all C source files, there is no reason to include it in .h or .c.in

.c.inc

> files.
> 
> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> ---
>  tests/style.yml | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/tests/style.yml b/tests/style.yml
> index 6d91ac6115..d2a0299a33 100644
> --- a/tests/style.yml
> +++ b/tests/style.yml
> @@ -143,3 +143,8 @@ osdep_h_in_source:
>      - tests/uefi-test-tools/.*
>      - tests/unit/test-rcu-(simpleq|slist|tailq)\.c
>      - tools/ebpf/rss.bpf.c
> +
> +osdep_h_in_header:
> +  files: \.(h|c\.inc)$
> +  prohibit: '#include "qemu/osdep\.h"'
> +  message: only C source files may include qemu/osdep.h

Should we also have a rule that rejects <qemu/osdep.h> in all files
(our only spelling should be with "", not <>)?
diff mbox series

Patch

diff --git a/tests/style.yml b/tests/style.yml
index 6d91ac6115..d2a0299a33 100644
--- a/tests/style.yml
+++ b/tests/style.yml
@@ -143,3 +143,8 @@  osdep_h_in_source:
     - tests/uefi-test-tools/.*
     - tests/unit/test-rcu-(simpleq|slist|tailq)\.c
     - tools/ebpf/rss.bpf.c
+
+osdep_h_in_header:
+  files: \.(h|c\.inc)$
+  prohibit: '#include "qemu/osdep\.h"'
+  message: only C source files may include qemu/osdep.h