From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.8 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 12F57C32750 for ; Tue, 13 Aug 2019 11:16:56 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id DF6C420679 for ; Tue, 13 Aug 2019 11:16:55 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org DF6C420679 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([::1]:51112 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hxUnP-0000cK-7l for qemu-devel@archiver.kernel.org; Tue, 13 Aug 2019 07:16:55 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:41412) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hxUmq-0000DG-BV for qemu-devel@nongnu.org; Tue, 13 Aug 2019 07:16:21 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hxUmp-0003vC-9d for qemu-devel@nongnu.org; Tue, 13 Aug 2019 07:16:20 -0400 Received: from mx1.redhat.com ([209.132.183.28]:51014) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1hxUmp-0003uC-0a for qemu-devel@nongnu.org; Tue, 13 Aug 2019 07:16:19 -0400 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id D0B0330FB8CD; Tue, 13 Aug 2019 11:16:17 +0000 (UTC) Received: from blackfin.pond.sub.org (ovpn-117-142.ams2.redhat.com [10.36.117.142]) by smtp.corp.redhat.com (Postfix) with ESMTPS id DE6B37EEDE; Tue, 13 Aug 2019 11:16:14 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 4C2ED1136444; Tue, 13 Aug 2019 13:16:11 +0200 (CEST) From: Markus Armbruster To: Alex =?utf-8?Q?Benn=C3=A9e?= References: <20190812052359.30071-1-armbru@redhat.com> <20190812052359.30071-12-armbru@redhat.com> <87blwuodot.fsf@linaro.org> <87y2zytsgi.fsf@dusky.pond.sub.org> <875zn1aacx.fsf@dusky.pond.sub.org> <875zn1ny4o.fsf@linaro.org> Date: Tue, 13 Aug 2019 13:16:11 +0200 In-Reply-To: <875zn1ny4o.fsf@linaro.org> ("Alex =?utf-8?Q?Benn=C3=A9e=22's?= message of "Tue, 13 Aug 2019 11:44:07 +0100") Message-ID: <87mugd71tw.fsf@dusky.pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.47]); Tue, 13 Aug 2019 11:16:17 +0000 (UTC) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.132.183.28 Subject: Re: [Qemu-devel] [PATCH v4 11/29] typedefs: Separate incomplete types and function types X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Philippe =?utf-8?Q?Mathieu-Dau?= =?utf-8?Q?d=C3=A9?= , Markus Armbruster , qemu-devel@nongnu.org Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Alex Benn=C3=A9e writes: > Markus Armbruster writes: > >> Markus Armbruster writes: >> >>> Alex Benn=C3=A9e writes: >>> >>>> Markus Armbruster writes: >>>> >>>>> While there, drop the obsolete file comment. >>>>> >>>>> Signed-off-by: Markus Armbruster >>>>> Reviewed-by: Philippe Mathieu-Daud=C3=A9 >>>>> Tested-by: Philippe Mathieu-Daud=C3=A9 >>>>> --- >>>>> include/qemu/typedefs.h | 12 ++++++++---- >>>>> 1 file changed, 8 insertions(+), 4 deletions(-) >>>>> >>>>> diff --git a/include/qemu/typedefs.h b/include/qemu/typedefs.h >>>>> index fcdaae58c4..29346648d4 100644 >>>>> --- a/include/qemu/typedefs.h >>>>> +++ b/include/qemu/typedefs.h >>>>> @@ -1,10 +1,10 @@ >>>>> #ifndef QEMU_TYPEDEFS_H >>>>> #define QEMU_TYPEDEFS_H >>>>> >>>>> -/* A load of opaque types so that device init declarations don't hav= e to >>>>> - pull in all the real definitions. */ >>>>> - >>>>> -/* Please keep this list in case-insensitive alphabetical order */ >>>>> +/* >>>>> + * Incomplete struct types >>>> >>>> Maybe expand this a little... >>>> >>>> "Incomplete struct types for modules that don't need the complete >>>> definitions but still pass around typed variables."? >>> >>> If we explain proper use of qemu/typedefs.h in HACKING, as discussed in >>> review of v1[*], we could point there. >> >> Perhaps rewriting the obsolete file comment would be better. Something >> like this: >> >> /* >> * This header is for selectively avoiding #include just to get a >> * typedef name. >> * >> * Declaring a typedef name in its "obvious" place can result in >> * inclusion cycles, in particular for complete struct and union >> * types that need more types for their members. It can also result >> * in headers pulling in many more headers, slowing down builds. >> * >> * You can break such cycles and unwanted dependencies by declaring >> * the typedef name here. >> * >> * For struct types used in only a few headers, judicious use of the >> * struct tag instead of the typedef name is commonly preferable. >> */ >> >> /* >> * Incomplete struct types >> * Please keep this list in case-insensitive alphabetical order. >> */ >> typedef struct AdapterInfo AdapterInfo; >> [...] >> >> /* >> * Pointer types >> * Such typedefs should be limited to cases where the typedef's users >> * are oblivious of its "pointer-ness". >> * Please keep this list in case-insensitive alphabetical order. >> */ >> typedef struct IRQState *qemu_irq; >> >> /* >> * Function types >> */ >> typedef void SaveStateHandler(QEMUFile *f, void *opaque); >> typedef int LoadStateHandler(QEMUFile *f, void *opaque, int version_= id); >> typedef void (*qemu_irq_handler)(void *opaque, int n, int level); >> >> What do you think? > > A definite improvement on what is currently there ;-) Amending my commit. Thanks!