diff options
| author | Eduardo Habkost <ehabkost@redhat.com> | 2012-10-23 19:44:02 -0200 |
|---|---|---|
| committer | Andreas Färber <afaerber@suse.de> | 2012-11-15 01:38:13 +0100 |
| commit | 04509ad939a7878b487b29e3500b79b5e2c1de35 (patch) | |
| tree | 5fb00ba4847b3e09e31b56bbe4d51174f175d66c | |
| parent | ce34cf72fe508b27a78f83c184142e8d1e6a048a (diff) | |
| download | qemu-04509ad939a7878b487b29e3500b79b5e2c1de35.tar.gz | |
qemu-common.h: Comment about usage rules
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 <ehabkost@redhat.com>
Signed-off-by: Andreas Färber <afaerber@suse.de>
| -rw-r--r-- | qemu-common.h | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/qemu-common.h b/qemu-common.h index ac9985cc6d..093d1198ec 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 |