From patchwork Wed Jul 22 16:44:06 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 51372 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-la0-f70.google.com (mail-la0-f70.google.com [209.85.215.70]) by patches.linaro.org (Postfix) with ESMTPS id E029E228EF for ; Wed, 22 Jul 2015 16:44:39 +0000 (UTC) Received: by laef2 with SMTP id f2sf60524838lae.0 for ; Wed, 22 Jul 2015 09:44:38 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:delivered-to:from:to:cc:subject :date:message-id:in-reply-to:references:x-original-sender :x-original-authentication-results:precedence:mailing-list:list-id :list-post:list-help:list-archive:list-unsubscribe; bh=fviOLrbhYC/9l9juOv6Z8EE7S3IjXzhHV7d5Tp8R7h4=; b=U2L7g7SY7rpe9p4v2YPr5+80b1jIHzQA/07Z1T+5Rf/wkLmGVrZ1r4gN0lcUecLQ2K S66rKywxSHOQnVlKwZz5hw8rR68IA/fu70SCDIxnqkSPirLqdDUuVB8Hy0Lx5tburNKw DV06vhAJ9Y+D4PlWRVSXxh3A+ZsHD/Jmpke/rw96l8ZfYJyLnDlUL6WoaNVWzhMHa+Fh yrTX5uBr0cMIqUGYYXDBAIZbIQIKsb5TQStyPaVjwuYiGQ5oshmxetk9Vn1ACHUo+Rt0 GzFKhD8Nf9mWcTKwmdetsSgSHC5fRN1YUWyeLaS9zH5Jy7vfwfz+pfkG4Z0TwIKkDetq dyBw== X-Gm-Message-State: ALoCoQkCYAswM0frnhKhytIZmq0B+nBpdl2GAfvDF2wDQTJSChNZM4Oc2O5ikrGWh83z8pashtPW X-Received: by 10.152.6.103 with SMTP id z7mr1596486laz.8.1437583478462; Wed, 22 Jul 2015 09:44:38 -0700 (PDT) MIME-Version: 1.0 X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.242.2 with SMTP id wm2ls111719lac.38.gmail; Wed, 22 Jul 2015 09:44:38 -0700 (PDT) X-Received: by 10.152.245.43 with SMTP id xl11mr740456lac.26.1437583478252; Wed, 22 Jul 2015 09:44:38 -0700 (PDT) Received: from mail-lb0-f180.google.com (mail-lb0-f180.google.com. [209.85.217.180]) by mx.google.com with ESMTPS id r2si1650433lae.66.2015.07.22.09.44.38 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 22 Jul 2015 09:44:38 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.180 as permitted sender) client-ip=209.85.217.180; Received: by lbbzr7 with SMTP id zr7so140656460lbb.1 for ; Wed, 22 Jul 2015 09:44:38 -0700 (PDT) X-Received: by 10.152.22.99 with SMTP id c3mr3355459laf.32.1437583478167; Wed, 22 Jul 2015 09:44:38 -0700 (PDT) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patches@linaro.org Received: by 10.112.7.198 with SMTP id l6csp46374lba; Wed, 22 Jul 2015 09:44:37 -0700 (PDT) X-Received: by 10.180.9.6 with SMTP id v6mr44026249wia.83.1437583464355; Wed, 22 Jul 2015 09:44:24 -0700 (PDT) Received: from mnementh.archaic.org.uk (mnementh.archaic.org.uk. [2001:8b0:1d0::1]) by mx.google.com with ESMTPS id l16si25681321wie.42.2015.07.22.09.44.24 for (version=TLSv1.2 cipher=RC4-SHA bits=128/128); Wed, 22 Jul 2015 09:44:24 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of pm215@archaic.org.uk designates 2001:8b0:1d0::1 as permitted sender) client-ip=2001:8b0:1d0::1; Received: from pm215 by mnementh.archaic.org.uk with local (Exim 4.80) (envelope-from ) id 1ZHx7r-0002Wz-NY; Wed, 22 Jul 2015 17:44:11 +0100 From: Peter Maydell To: qemu-devel@nongnu.org Cc: patches@linaro.org Subject: [PATCH 07/12] osdep.h: Add header comment Date: Wed, 22 Jul 2015 17:44:06 +0100 Message-Id: <1437583451-9677-8-git-send-email-peter.maydell@linaro.org> X-Mailer: git-send-email 1.7.10.4 In-Reply-To: <1437583451-9677-1-git-send-email-peter.maydell@linaro.org> References: <1437583451-9677-1-git-send-email-peter.maydell@linaro.org> X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: peter.maydell@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.180 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Precedence: list Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org List-ID: X-Google-Group-Id: 836684582541 List-Post: , List-Help: , List-Archive: List-Unsubscribe: , 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