[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH 01/11] qemu-common.h: Comment about usage rules
From: |
Andreas Färber |
Subject: |
[Qemu-devel] [PATCH 01/11] qemu-common.h: Comment about usage rules |
Date: |
Thu, 15 Nov 2012 04:06:37 +0100 |
From: Eduardo Habkost <address@hidden>
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 from other headers, and we should gradually
move the declarations from the catch-all 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>
Signed-off-by: Andreas Färber <address@hidden>
---
qemu-common.h | 11 ++++++++++-
1 Datei geändert, 10 Zeilen hinzugefügt(+), 1 Zeile entfernt(-)
diff --git a/qemu-common.h b/qemu-common.h
index ac9985c..093d119 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 file 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.10.4
- [Qemu-devel] [PULL for-1.3] QOM CPUState patch queue 2012-11-15, Andreas Färber, 2012/11/14
- [Qemu-devel] [PATCH 01/11] qemu-common.h: Comment about usage rules,
Andreas Färber <=
- [Qemu-devel] [PATCH 03/11] qdev: Split up header so it can be used in cpu.h, Andreas Färber, 2012/11/14
- [Qemu-devel] [PATCH 02/11] Move qemu_irq typedef out of qemu-common.h, Andreas Färber, 2012/11/14
- [Qemu-devel] [PATCH 05/11] vnc-palette.h: Include <stdbool.h>, Andreas Färber, 2012/11/14
- [Qemu-devel] [PATCH 04/11] qemu-fsdev-dummy.c: Include module.h, Andreas Färber, 2012/11/14
- [Qemu-devel] [PATCH 06/11] qemu-config.h: Include headers it needs, Andreas Färber, 2012/11/14
- [Qemu-devel] [PATCH 07/11] osdep: Move qemu_{open, close}() prototypes, Andreas Färber, 2012/11/14
- [Qemu-devel] [PATCH 08/11] qapi-types.h: Don't include qemu-common.h, Andreas Färber, 2012/11/14
- [Qemu-devel] [PATCH 09/11] target-i386/cpu: Name new CPUID bits, Andreas Färber, 2012/11/14