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 ED359C5474C for ; Sat, 31 Aug 2024 06:03:12 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1skHBs-0007WL-9u; Sat, 31 Aug 2024 02:02:28 -0400 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 1skHBq-0007Vq-LT for qemu-devel@nongnu.org; Sat, 31 Aug 2024 02:02:26 -0400 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 1skHBn-0005VR-NI for qemu-devel@nongnu.org; Sat, 31 Aug 2024 02:02:26 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1725084141; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=poK3AJLJcxJA0UQrAX+HomRkyr8dbZIkyCIp4XPNacw=; b=Q57uAvM32+0v014uYUH5dYoG5bcJv/rHcqiyjxd/lyApZO2LbbVCYnIAvawxL80Y7sw0/s FrzqGYuSb08AO2zb3khOT6K6Nt1BRkSqf11AsGkvikX6BNMasuWV6pOWykVogYziZ3FO38 V5sL/s2L2QSwc1La1V3FLOgfzPvYj+M= Received: from mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-376-3dee6wi0Pt6swvQMNPyLvw-1; Sat, 31 Aug 2024 02:02:19 -0400 X-MC-Unique: 3dee6wi0Pt6swvQMNPyLvw-1 Received: from mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.12]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id A0B381956064; Sat, 31 Aug 2024 06:02:17 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.112]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id B36191955F29; Sat, 31 Aug 2024 06:02:16 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 66F2321E6A28; Sat, 31 Aug 2024 08:02:14 +0200 (CEST) From: Markus Armbruster To: John Snow Cc: qemu-devel@nongnu.org, Cleber Rosa , =?utf-8?Q?Mar?= =?utf-8?Q?c-Andr=C3=A9?= Lureau , Thomas Huth , Peter Maydell , Beraldo Leal , Michael Roth , Paolo Bonzini , Daniel P. =?utf-8?Q?Berrang=C3=A9?= , Philippe =?utf-8?Q?Mathieu-Daud=C3=A9?= Subject: Re: [PATCH 2/8] python/qapi: change "FIXME" to "TODO" In-Reply-To: (John Snow's message of "Fri, 30 Aug 2024 14:33:12 -0400") References: <20240820002318.1380276-1-jsnow@redhat.com> <20240820002318.1380276-3-jsnow@redhat.com> <87ikvicln3.fsf@pond.sub.org> Date: Sat, 31 Aug 2024 08:02:14 +0200 Message-ID: <87v7zh8c2h.fsf@pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 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_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham 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 John Snow writes: > On Fri, Aug 30, 2024 at 7:09=E2=80=AFAM Markus Armbruster wrote: > >> John Snow writes: >> >> > qemu.git/python/setup.cfg disallows checking in any code with "XXX", >> > "FIXME" or "TODO" in the comments. Soften the restriction to only >> > prohibit "FIXME", and change the two occurrences of "FIXME" in qapi to >> > read "TODO" instead. >> > >> > Signed-off-by: John Snow >> >> I don't like forbidding FIXME comments. It's as futile as forbidding >> known bugs. All it can accomplish is making people use other, and >> likely less clear ways to document them. >> >> Perhaps projects exist that use FIXME comments only for known bugs in >> uncommitted code. To me, that feels *nuts*. I commit all kinds of crap >> in my tree. I don't need silly "make check" failures while I develop, >> the non-silly ones cause enough friction already. >> >> In fact, we're quite happy to use FIXME comments even in merged code: >> >> $ git-grep FIXME | wc -l >> 494 >> >> I can't see why python/ should be different. >> >> > --- >> > python/setup.cfg | 5 +++++ >> > scripts/qapi/commands.py | 2 +- >> > scripts/qapi/events.py | 2 +- >> > 3 files changed, 7 insertions(+), 2 deletions(-) >> > >> > diff --git a/python/setup.cfg b/python/setup.cfg >> > index 3b4e2cc5501..72b58c98c99 100644 >> > --- a/python/setup.cfg >> > +++ b/python/setup.cfg >> > @@ -169,6 +169,11 @@ ignore-signatures=3Dyes >> > # TODO: Remove after we opt in to Pylint 2.8.3. See commit msg. >> > min-similarity-lines=3D6 >> > >> > +[pylint.miscellaneous] >> > + >> > +# forbid FIXME/XXX comments, allow TODO. >> > +notes=3DFIXME, >> > + XXX, >> > >> > [isort] >> > force_grid_wrap=3D4 >> > diff --git a/scripts/qapi/commands.py b/scripts/qapi/commands.py >> > index 79951a841f5..cffed6cd3ba 100644 >> > --- a/scripts/qapi/commands.py >> > +++ b/scripts/qapi/commands.py >> > @@ -385,7 +385,7 @@ def visit_command(self, >> > coroutine: bool) -> None: >> > if not gen: >> > return >> > - # FIXME: If T is a user-defined type, the user is responsible >> > + # TODO: If T is a user-defined type, the user is responsible >> > # for making this work, i.e. to make T's condition the >> > # conjunction of the T-returning commands' conditions. If T >> > # is a built-in type, this isn't possible: the >> > diff --git a/scripts/qapi/events.py b/scripts/qapi/events.py >> > index d1f639981a9..36dc0c50c78 100644 >> > --- a/scripts/qapi/events.py >> > +++ b/scripts/qapi/events.py >> > @@ -84,7 +84,7 @@ def gen_event_send(name: str, >> > boxed: bool, >> > event_enum_name: str, >> > event_emit: str) -> str: >> > - # FIXME: Our declaration of local variables (and of 'errp' in the >> > + # TODO: Our declaration of local variables (and of 'errp' in the >> > # parameter list) can collide with exploded members of the event's >> > # data type passed in as parameters. If this collision ever hits= in >> > # practice, we can rename our local variables with a leading pref= ix, >> >> Starting a comment with TODO tells me there's work to do. >> >> Starting it with FIXME tells me there's a bug to fix. That's more >> specific. Replacing FIXME by TODO loses information. > > meh. I do use the "prohibit fixme" personally because I've the memory of a > goldfish and I like setting up bombs for myself when I run tests, but > willing to cede if it gets me what I want otherwise. I could be coerced to > using "XXX" as my WIP testing bomb. Or maybe literally just adding "WIP" = as > a new bomb. Is that a fair trade? I understand you'd like to have some kind of stylized comment that automated testing will reject, to serve as a "do not post before resolving this issue" reminder. Fair? If yes, whatever floats your boat and doesn't interfere with existing practice. $ git-grep -w FIXME | wc -l 493 $ git-grep -w TODO | wc -l 1249 $ git-grep -w XXX | wc -l 78288 $ git-grep -w WIP Binary file pc-bios/skiboot.lid matches > There are likely other standards differences between the two subtrees, > potentially things like documentation string length and so on -- I invite > you to take a look at the setup.cfg file and tweak things to your liking > and run "make check-minreqs" to see what barks, if anything. > > After you run that command, you can type "source .dev-venv/bin/activate.s= h" > (or .fish or whatever) and then "pylint --generate-rcfile | less" to get a > sample config and see all of the buttons, knobs and levers you could pull. > You can leave the environment when you're done with "deactivate". > > Mentioning this only because there have been times in the past that my > formatting hasn't been to your liking, but there are avenues to > programmatically enforce it to make my qapi patches nicer for your tastes > in the future. Thanks!