aboutsummaryrefslogtreecommitdiff
path: root/docs/devel/style.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/devel/style.rst')
-rw-r--r--docs/devel/style.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/devel/style.rst b/docs/devel/style.rst
index 7ddd42b6c2..68aa776930 100644
--- a/docs/devel/style.rst
+++ b/docs/devel/style.rst
@@ -293,6 +293,13 @@ that QEMU depends on.
Do not include "qemu/osdep.h" from header files since the .c file will have
already included it.
+Headers should normally include everything they need beyond osdep.h.
+If exceptions are needed for some reason, they must be documented in
+the header. If all that's needed from a header is typedefs, consider
+putting those into qemu/typedefs.h instead of including the header.
+
+Cyclic inclusion is forbidden.
+
C types
=======