[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 16/18] docs/devel: make a statement about includes
From: |
Alex Bennée |
Subject: |
[PATCH 16/18] docs/devel: make a statement about includes |
Date: |
Mon, 24 Apr 2023 10:22:47 +0100 |
While not explicitly disallowing header macro abuse (because that
would make us hypocrites) lets at least address some things to think
about.
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Reviewed-by: Juan Quintela <quintela@redhat.com>
Message-Id: <20230420155723.1711048-8-alex.bennee@linaro.org>
---
docs/devel/style.rst | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/docs/devel/style.rst b/docs/devel/style.rst
index 68aa776930..5bc6f2f095 100644
--- a/docs/devel/style.rst
+++ b/docs/devel/style.rst
@@ -300,6 +300,20 @@ putting those into qemu/typedefs.h instead of including
the header.
Cyclic inclusion is forbidden.
+Generative Includes
+-------------------
+
+QEMU makes fairly extensive use of the macro pre-processor to
+instantiate multiple similar functions. While such abuse of the macro
+processor isn't discouraged it can make debugging and code navigation
+harder. You should consider carefully if the same effect can be
+achieved by making it easy for the compiler to constant fold or using
+python scripting to generate grep friendly code.
+
+If you do use template header files they should be named with the
+``.c.inc`` or ``.h.inc`` suffix to make it clear they are being
+included for expansion.
+
C types
=======
--
2.39.2
- [PATCH 17/18] docs/devel: mention the spacing requirement for QOM, (continued)
- [PATCH 17/18] docs/devel: mention the spacing requirement for QOM, Alex Bennée, 2023/04/24
- [PATCH 15/18] docs/system: remove excessive punctuation from guest-loader docs, Alex Bennée, 2023/04/24
- [PATCH 07/18] .gitlab-ci.d/cirrus: Drop the CI job for compiling with FreeBSD 12, Alex Bennée, 2023/04/24
- [PATCH 12/18] tests/avocado/tuxrun_baselines.py: improve code coverage for ppc64, Alex Bennée, 2023/04/24
- [PATCH 09/18] tests/avocado/machine_aspeed: Fix the broken ast2[56]00_evb_sdk tests, Alex Bennée, 2023/04/24
- [PATCH 11/18] avocado_qemu/__init__.py: factor out the qemu-img finding, Alex Bennée, 2023/04/24
- [PATCH 13/18] tests/tcg: limit the scope of the plugin tests, Alex Bennée, 2023/04/24
- [PATCH 18/18] docs/style: call out the use of GUARD macros, Alex Bennée, 2023/04/24
- [PATCH 16/18] docs/devel: make a statement about includes,
Alex Bennée <=