From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:59866) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZLE9o-00070D-It for qemu-devel@nongnu.org; Fri, 31 Jul 2015 13:31:50 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ZLE9i-0006dp-Ca for qemu-devel@nongnu.org; Fri, 31 Jul 2015 13:31:44 -0400 Received: from mx1.redhat.com ([209.132.183.28]:50240) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZLE9i-0006dh-8D for qemu-devel@nongnu.org; Fri, 31 Jul 2015 13:31:38 -0400 Date: Fri, 31 Jul 2015 18:31:34 +0100 From: "Daniel P. Berrange" Message-ID: <20150731173134.GU2392@redhat.com> References: <1437583451-9677-1-git-send-email-peter.maydell@linaro.org> <1437583451-9677-8-git-send-email-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline In-Reply-To: <1437583451-9677-8-git-send-email-peter.maydell@linaro.org> Subject: Re: [Qemu-devel] [PATCH 07/12] osdep.h: Add header comment Reply-To: "Daniel P. Berrange" List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Peter Maydell Cc: qemu-devel@nongnu.org, patches@linaro.org On Wed, Jul 22, 2015 at 05:44:06PM +0100, Peter Maydell wrote: > 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(+) Reviewed-by: Daniel P. Berrange > > 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. > + */ Regards, Daniel -- |: http://berrange.com -o- http://www.flickr.com/photos/dberrange/ :| |: http://libvirt.org -o- http://virt-manager.org :| |: http://autobuild.org -o- http://search.cpan.org/~danberr/ :| |: http://entangle-photo.org -o- http://live.gnome.org/gtk-vnc :|