From patchwork Wed Oct 24 03:01:47 2012 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Eduardo Habkost X-Patchwork-Id: 193625 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (Client did not present a certificate) by ozlabs.org (Postfix) with ESMTPS id 0BB292C0147 for ; Wed, 24 Oct 2012 14:01:50 +1100 (EST) Received: from localhost ([::1]:43640 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1TQrE3-0003TZ-Kn for incoming@patchwork.ozlabs.org; Tue, 23 Oct 2012 23:01:47 -0400 Received: from eggs.gnu.org ([208.118.235.92]:46936) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1TQrDp-0003T8-0l for qemu-devel@nongnu.org; Tue, 23 Oct 2012 23:01:34 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1TQrDo-0006Fu-2b for qemu-devel@nongnu.org; Tue, 23 Oct 2012 23:01:32 -0400 Received: from mx1.redhat.com ([209.132.183.28]:57423) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1TQrDn-0006Fi-Qg for qemu-devel@nongnu.org; Tue, 23 Oct 2012 23:01:31 -0400 Received: from int-mx02.intmail.prod.int.phx2.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) by mx1.redhat.com (8.14.4/8.14.4) with ESMTP id q9O31Kj2019173 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Tue, 23 Oct 2012 23:01:20 -0400 Received: from blackpad.lan.raisama.net (vpn1-4-96.gru2.redhat.com [10.97.4.96]) by int-mx02.intmail.prod.int.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id q9O31K0q029829; Tue, 23 Oct 2012 23:01:20 -0400 Received: by blackpad.lan.raisama.net (Postfix, from userid 500) id 5E7232031C0; Wed, 24 Oct 2012 01:02:11 -0200 (BRST) From: Eduardo Habkost To: qemu-devel@nongnu.org Date: Wed, 24 Oct 2012 01:01:47 -0200 Message-Id: <1351047728-20360-4-git-send-email-ehabkost@redhat.com> In-Reply-To: <1351047728-20360-1-git-send-email-ehabkost@redhat.com> References: <1351047728-20360-1-git-send-email-ehabkost@redhat.com> X-Scanned-By: MIMEDefang 2.67 on 10.5.11.12 X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 209.132.183.28 Cc: peter.maydell@linaro.org, riku.voipio@iki.fi, blauwirbel@gmail.com, Anthony Liguori , Igor Mammedov , =?UTF-8?q?Andreas=20F=C3=A4rber?= Subject: [Qemu-devel] [PATCH 03/24] qemu-common.h: comment about usage rules X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Sender: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org 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 on other headers, and we should gradually move the declarations from the catchall 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 --- qemu-common.h | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/qemu-common.h b/qemu-common.h index b54612b..630bfa0 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 files 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