[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH 03/24] qemu-common.h: comment about usage rules
From: |
Eduardo Habkost |
Subject: |
[Qemu-devel] [PATCH 03/24] qemu-common.h: comment about usage rules |
Date: |
Wed, 24 Oct 2012 01:01:47 -0200 |
Every time we make a tiny change on a header file, we often find
circular header dependency problems. To avoid this nightmare, we need to
stop including qemu-common.h on other headers, and we should gradually
move the declarations from the catchall qemu-common.h header to their
specific headers.
This simply adds a comment documenting the rules about qemu-common.h,
hoping that people will see it before including qemu-common.h from other
header files, and before adding more declarations to qemu-common.h.
Signed-off-by: Eduardo Habkost <address@hidden>
---
qemu-common.h | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/qemu-common.h b/qemu-common.h
index b54612b..630bfa0 100644
--- a/qemu-common.h
+++ b/qemu-common.h
@@ -1,5 +1,14 @@
-/* Common header file that is included by all of qemu. */
+/* Common header file that is included by all of qemu.
+ *
+ * This file is supposed to be included only by .c files. No header file should
+ * depend on qemu-common.h, as this would easily lead to circular header
+ * dependencies.
+ *
+ * If a header files uses a definition from qemu-common.h, that definition
+ * must be moved to a separate header file, and the header that uses it
+ * must include that header.
+ */
#ifndef QEMU_COMMON_H
#define QEMU_COMMON_H
--
1.7.11.7
- [Qemu-devel] [PATCH v5 00/24] CPU DeviceState, 5th try, Eduardo Habkost, 2012/10/23
- [Qemu-devel] [PATCH 03/24] qemu-common.h: comment about usage rules,
Eduardo Habkost <=
- [Qemu-devel] [PATCH 09/24] ui/vnc-pallete.c: include headers it needs, Eduardo Habkost, 2012/10/23
- [Qemu-devel] [PATCH 01/24] user: move *-user/qemu-types.h to main directory, Eduardo Habkost, 2012/10/23
- [Qemu-devel] [PATCH 15/24] qlist.h: do not include qemu-common.h, Eduardo Habkost, 2012/10/23
- [Qemu-devel] [PATCH 16/24] qapi-types.h: don't include qemu-common.h, Eduardo Habkost, 2012/10/23
- [Qemu-devel] [PATCH 10/24] qemu-config.h: include headers it needs, Eduardo Habkost, 2012/10/23
- [Qemu-devel] [PATCH 06/24] move I/O-related definitions from qemu-common.h to a new header (qemu-stdio.h), Eduardo Habkost, 2012/10/23
- [Qemu-devel] [PATCH 14/24] sysemu.h: include qemu-types.h instead of qemu-common.h, Eduardo Habkost, 2012/10/23
- [Qemu-devel] [PATCH 08/24] vnc-palette.h: include <stdbool.h>, Eduardo Habkost, 2012/10/23
- [Qemu-devel] [PATCH 11/24] qapi/qmp-registry.c: include headers it needs, Eduardo Habkost, 2012/10/23
- [Qemu-devel] [PATCH 04/24] move qemu_irq typedef out of cpu-common.h, Eduardo Habkost, 2012/10/23