[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH 07/12] osdep.h: Add header comment
From: |
Daniel P. Berrange |
Subject: |
Re: [Qemu-devel] [PATCH 07/12] osdep.h: Add header comment |
Date: |
Fri, 31 Jul 2015 18:31:34 +0100 |
User-agent: |
Mutt/1.5.23 (2014-03-12) |
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 <address@hidden>
> ---
> include/qemu/osdep.h | 24 ++++++++++++++++++++++++
> 1 file changed, 24 insertions(+)
Reviewed-by: Daniel P. Berrange <address@hidden>
>
> 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 :|
- [Qemu-devel] [PATCH 01/12] qapi/qmp-event.c: Don't manually include os-win32.h/os-posix.h, (continued)
- [Qemu-devel] [PATCH 01/12] qapi/qmp-event.c: Don't manually include os-win32.h/os-posix.h, Peter Maydell, 2015/07/22
- [Qemu-devel] [PATCH 06/12] osdep.h: Move some OS header includes and fixups from qemu-common.h, Peter Maydell, 2015/07/22
- [Qemu-devel] [PATCH 04/12] compiler.h: Use glue() in QEMU_BUILD_BUG_ON define, Peter Maydell, 2015/07/22
- [Qemu-devel] [PATCH 09/12] apic_internal.h: Include cpu.h directly, Peter Maydell, 2015/07/22
- [Qemu-devel] [PATCH 03/12] osdep.h: Move some compiler-specific things to compiler.h, Peter Maydell, 2015/07/22
- [Qemu-devel] [PATCH 07/12] osdep.h: Add header comment, Peter Maydell, 2015/07/22
- Re: [Qemu-devel] [PATCH 07/12] osdep.h: Add header comment,
Daniel P. Berrange <=
- [Qemu-devel] [PATCH 08/12] qemu-common.h: Move muldiv64() to host-utils.h, Peter Maydell, 2015/07/22
- [Qemu-devel] [PATCH 02/12] osdep.h: Remove qemu_printf, Peter Maydell, 2015/07/22
- [Qemu-devel] [PATCH 05/12] qemu-common.h: Move Win32 fixups into os-win32.h, Peter Maydell, 2015/07/22
- Re: [Qemu-devel] [PATCH 00/12] qemu-common.h/osdep.h refactoring, Paolo Bonzini, 2015/07/22
- Re: [Qemu-devel] [PATCH 00/12] qemu-common.h/osdep.h refactoring, Markus Armbruster, 2015/07/23
- Re: [Qemu-devel] [PATCH 00/12] qemu-common.h/osdep.h refactoring, Daniel P. Berrange, 2015/07/31