From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:46100) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZHx85-0007ll-NO for qemu-devel@nongnu.org; Wed, 22 Jul 2015 12:44:26 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ZHx83-0004fg-VX for qemu-devel@nongnu.org; Wed, 22 Jul 2015 12:44:25 -0400 Received: from mnementh.archaic.org.uk ([2001:8b0:1d0::1]:34676) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZHx83-0004ZT-NO for qemu-devel@nongnu.org; Wed, 22 Jul 2015 12:44:23 -0400 From: Peter Maydell Date: Wed, 22 Jul 2015 17:44:06 +0100 Message-Id: <1437583451-9677-8-git-send-email-peter.maydell@linaro.org> In-Reply-To: <1437583451-9677-1-git-send-email-peter.maydell@linaro.org> References: <1437583451-9677-1-git-send-email-peter.maydell@linaro.org> Subject: [Qemu-devel] [PATCH 07/12] osdep.h: Add header comment List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu-devel@nongnu.org Cc: patches@linaro.org Add a header comment to osdep.h, explaining what the header is for and some rules to avoid circular-include difficulties. Signed-off-by: Peter Maydell --- include/qemu/osdep.h | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/include/qemu/osdep.h b/include/qemu/osdep.h index 60ac27d..ab3c876 100644 --- a/include/qemu/osdep.h +++ b/include/qemu/osdep.h @@ -1,3 +1,27 @@ +/* + * OS includes and handling of OS dependencies + * + * This header exists to pull in some common system headers that + * most code in QEMU will want, and to fix up some possible issues with + * it (missing defines, Windows weirdness, and so on). + * + * To avoid getting into possible circular include dependencies, this + * file should not include any other QEMU headers, with the exceptions + * of config-host.h, compiler.h, os-posix.h and os-win32.h, all of which + * are doing a similar job to this file and are under similar constraints. + * + * This header also contains prototypes for functions defined in + * os-*.c and util/oslib-*.c; those would probably be better split + * out into separate header files. + * + * In an ideal world this header would contain only: + * (1) things which everybody needs + * (2) things without which code would work on most platforms but + * fail to compile or misbehave on a minority of host OSes + * + * This work is licensed under the terms of the GNU GPL, version 2 or later. + * See the COPYING file in the top-level directory. + */ #ifndef QEMU_OSDEP_H #define QEMU_OSDEP_H -- 1.9.1