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 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 smtp.lore.kernel.org (Postfix) with ESMTPS id 85810C61DA4 for ; Thu, 2 Feb 2023 09:02:42 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pNVTF-0001ck-6W; Thu, 02 Feb 2023 04:01:29 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pNVT4-0001Pa-6E for qemu-devel@nongnu.org; Thu, 02 Feb 2023 04:01:19 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pNVT0-0004C0-5Y for qemu-devel@nongnu.org; Thu, 02 Feb 2023 04:01:15 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1675328472; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=4AhbSG4hXE/hof6E5D603yBgb5Yh7vDIHNwcFGx67Mw=; b=TzuN7RbkkVpzUr/ajMtwzfquvEFSCjjN/dt+oji6KTcYcPaRcyUpcy/ZsP29VSbQrbb6Wj wNnrpbgbJNUxckmwggZuYIVTUxU4xZE39K9DLg+sg1KZVQwnMR8NWCHLzEgbymH5ofFDyS kGMTapVRW+9vpPB+HNnZJtaRxQ055Lc= Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-460-vc_3QRh2N8uZ36COk6DkCw-1; Thu, 02 Feb 2023 04:01:07 -0500 X-MC-Unique: vc_3QRh2N8uZ36COk6DkCw-1 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 04C87101A52E; Thu, 2 Feb 2023 09:00:52 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.70]) by smtp.corp.redhat.com (Postfix) with ESMTPS id D6CEF140EBF6; Thu, 2 Feb 2023 09:00:50 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 3DC2B21E6A1F; Thu, 2 Feb 2023 10:00:49 +0100 (CET) From: Markus Armbruster To: Juan Quintela Cc: qemu-devel@nongnu.org, richard.henderson@linaro.org, pbonzini@redhat.com, kwolf@redhat.com, hreitz@redhat.com, imp@bsdimp.com, kevans@freebsd.org, berrange@redhat.com, groug@kaod.org, qemu_oss@crudebyte.com, mst@redhat.com, philmd@linaro.org, peter.maydell@linaro.org, alistair@alistair23.me, jasowang@redhat.com, jonathan.cameron@huawei.com, kbastian@mail.uni-paderborn.de, dgilbert@redhat.com, michael.roth@amd.com, kkostiuk@redhat.com, tsimpson@quicinc.com, palmer@dabbelt.com, bin.meng@windriver.com, qemu-block@nongnu.org, qemu-arm@nongnu.org, qemu-riscv@nongnu.org Subject: Re: [PATCH v5 04/20] scripts/clean-includes: Improve --git commit message References: <20230130132156.1868019-1-armbru@redhat.com> <20230130132156.1868019-5-armbru@redhat.com> <87sffsnmb2.fsf@secure.mitica> <875ycly2h5.fsf@pond.sub.org> <87bkmdfrys.fsf@secure.mitica> <87cz6twldq.fsf@pond.sub.org> <877cx11lny.fsf@secure.mitica> Date: Thu, 02 Feb 2023 10:00:49 +0100 In-Reply-To: <877cx11lny.fsf@secure.mitica> (Juan Quintela's message of "Wed, 01 Feb 2023 15:54:09 +0100") Message-ID: <87k010phku.fsf@pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-Scanned-By: MIMEDefang 3.1 on 10.11.54.7 Received-SPF: pass client-ip=170.10.133.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=unavailable autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Juan Quintela writes: > Markus Armbruster wrote: >> Juan Quintela writes: >> >>> Markus Armbruster wrote: >>>> Juan Quintela writes: >>>> >>>>> Markus Armbruster wrote: >>>>>> The script drops #include "qemu/osdep.h" from headers. Mention it in >>>>>> the commit message it uses for --git. >>>>>> >>>>>> Signed-off-by: Markus Armbruster >>>>>> --- >>>>>> scripts/clean-includes | 4 ++-- >>>>>> 1 file changed, 2 insertions(+), 2 deletions(-) >>>>>> >>>>>> diff --git a/scripts/clean-includes b/scripts/clean-includes >>>>>> index f0466a6262..f9722c3aec 100755 >>>>>> --- a/scripts/clean-includes >>>>>> +++ b/scripts/clean-includes >>>>>> @@ -193,8 +193,8 @@ if [ "$GIT" = "yes" ]; then >>>>>> git commit --signoff -F - <>>>>> $GITSUBJ: Clean up includes >>>>>> >>>>>> -Clean up includes so that osdep.h is included first and headers >>>>>> -which it implies are not included manually. >>>>>> +Clean up includes so that qemu/osdep.h is included first in .c, and >>>>>> +not in .h, and headers which it implies are not included manually. >>>>> >>>>> I give a tree. >>>>> >>>>> Clean up includes so qemu/osdep.h is never used in .h files. It makes >>>>> sure that qemu/osdep.h is only used in .c files. Once there, it assures >>>>> that .h files already included in qemu/osdep.h are not included a second >>>>> time on the .c file. >>>>> >>>>> What do you think? >>>> >>>> Neglects to mention qemu/osdep.h goes first in .c. >>> >>> /me tries again >>> >>> What about: >>> >>> The file qemu/osdep.h should only be included in .c files. And it has >>> to be the first included file. >> >> Suggest "has to be included first." > > Ok to this change. > >> >>> This script does several things: >>> - Remove qemu/osdep.h from .h files. >> >> Correct. Could say "inclusion of qemu/osdep.h" > > I try to minimize whatever word that "includes" "includ*" (pun intended). > >>> - If qemu/osdep.h is included in a .c file it is moved to the first >>> included position if it is anywhere else. >> >> Not quite. The script ensures all the .c include it, and include it >> first. > > Oh, then it is easier. > > - It ensures that qemu/osdep.h is the first included file in all .c files. > >>> - Remove from .h files all include files that are already present in >>> qemu/osdep.h. >> >> They're removed from .h, too. > > Ah, didn't know this bit. > >> Sure you want to continue wordsmithing? ;) > > Yeap, I *hate* error messages that I can't parse (or have to read it ten > times before I understand them). > > So, we end with: > > The file qemu/osdep.h should only be included in .c files. And it has > to be included first. > > This script does three things: > - Remove qemu/osdep.h from .h files. > - It ensures that qemu/osdep.h is the first included file in all .c files. > - Include files contained in qemu/osdep.h are removed form all .c and .h > files. > > Is this better? It's less terse. Fine with me. The mix of passive and active voice feels a bit awkward, though. Another try: All .c should include qemu/osdep.h first. This script performs three related cleanups: * Ensure .c files include qemu/osdep.h first. * Including it in a .h is redundant, since the .c already includes it. Drop such inclusions. * Likewise, including headers qemu/osdep.h includes is redundant. Drop these, too.