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 AD98DC3064D for ; Fri, 28 Jun 2024 14:37:30 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sNCiY-000666-BC; Fri, 28 Jun 2024 10:36:50 -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 1sNCiX-00065T-0V for qemu-devel@nongnu.org; Fri, 28 Jun 2024 10:36:49 -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 1sNCiV-0003uP-D5 for qemu-devel@nongnu.org; Fri, 28 Jun 2024 10:36:48 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1719585405; 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=QM7eQrwLC79kjpAR0BXKRomvhlSBINXfF7dfvlkf+tA=; b=czQwO3wKH5O3sCrB3yXsC+8+ITYDRfY8XMjCiZ120tiVER3xTytdXLXyNgTvAZmjWpKOvQ Y7EoT9DizYw6Brh1FUtv9BG5YAqwTvJmeXxBaqQNyzFyxTbgj+13/b5aoFKzEw0sQKY19P eLKn1/LDfUdKdoris7BpQWFfodvG4HE= Received: from mail-pg1-f199.google.com (mail-pg1-f199.google.com [209.85.215.199]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-66-sc5Lc1JuPVaGv6xuaimSPQ-1; Fri, 28 Jun 2024 10:36:42 -0400 X-MC-Unique: sc5Lc1JuPVaGv6xuaimSPQ-1 Received: by mail-pg1-f199.google.com with SMTP id 41be03b00d2f7-72268cc4453so553642a12.3 for ; Fri, 28 Jun 2024 07:36:42 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1719585402; x=1720190202; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=QM7eQrwLC79kjpAR0BXKRomvhlSBINXfF7dfvlkf+tA=; b=N1yzQGhbsbRwEFIDkWqq4m7F083OTs8d2ZLB/Szd2SNsFcaX2SzAtGjLxZ8f37b56l WonQhgsT22Ga9W3ttJoBodMRu3nF10N9Pm0ivr6NRjvnVjnnjpJNFNnZaiQ6Etb7gVkH euuz0mNWtll+4K/71HrxjuH8XtbKhWvfCMMQiR+eDJD+wooHbiEbiPoFMx+pFYxZIjoy SwHRe3F8IhaBToX5R74veA/Y1HArYIKoDhmjOU1/U3dwlOvLgL/Tsotv83TlcEmt6NgU jlvysbD9UV1KDQEyYr4rO4tScw/7ix7/abFW8XHCo0y5Z/94NWXrp/znpEK9IzFgw3q5 W72g== X-Gm-Message-State: AOJu0YyA/F2yXE2opOt1FwmsAOHszm0bVqGVSlWePN4K8sGCB+7gvoOD maX/2Ju0Sd4MWGdmdWKDIpkMzgj0+7P8xaYuQBYPUZKxi31N+VoNQD/9dIQpbdk2JUiKfxIJJsz T/3l3kRGgBWNsa+8hKtGq4bQ+ijaOLRDyezR2pqoQHxTB8KPpQ4y+CcLV7UfLKCbrFmFNt+YeBT XFIG0KKEpJ5YOMmFHF/Kx/0NEk3O8= X-Received: by 2002:a05:6a20:6d83:b0:1bd:2d4e:53e1 with SMTP id adf61e73a8af0-1bd2d4e556amr7544635637.46.1719585401698; Fri, 28 Jun 2024 07:36:41 -0700 (PDT) X-Google-Smtp-Source: AGHT+IHRhGlDtwizJdIFH5jGVPkJPW/PFNo1Sh4BqvsVFXDPYKiHimapkmcPPhbe03/gP0tPsbeGN8aYEMryb/WVrzg= X-Received: by 2002:a05:6a20:6d83:b0:1bd:2d4e:53e1 with SMTP id adf61e73a8af0-1bd2d4e556amr7544590637.46.1719585401221; Fri, 28 Jun 2024 07:36:41 -0700 (PDT) MIME-Version: 1.0 References: <20240626222128.406106-1-jsnow@redhat.com> <20240626222128.406106-5-jsnow@redhat.com> <874j9d1q61.fsf@pond.sub.org> In-Reply-To: <874j9d1q61.fsf@pond.sub.org> From: John Snow Date: Fri, 28 Jun 2024 10:36:29 -0400 Message-ID: Subject: Re: [PATCH v2 04/21] docs/qapidoc: delint a tiny portion of the module To: Markus Armbruster Cc: qemu-devel , Mads Ynddal , Jiri Pirko , Stefan Hajnoczi , Eric Blake , Peter Maydell , Michael Roth , "Michael S. Tsirkin" , Alex Williamson , Pavel Dovgalyuk , Victor Toso de Carvalho , =?UTF-8?Q?C=C3=A9dric_Le_Goater?= , =?UTF-8?Q?Daniel_P=2E_Berrang=C3=A9?= , Qemu-block , Ani Sinha , Fabiano Rosas , Marcel Apfelbaum , =?UTF-8?B?TWFyYy1BbmRyw6kgTHVyZWF1?= , Gerd Hoffmann , Paolo Bonzini , Kevin Wolf , Peter Xu , Eduardo Habkost , =?UTF-8?Q?Philippe_Mathieu=2DDaud=C3=A9?= , Lukas Straub , Igor Mammedov , Jason Wang , Yanan Wang , Hanna Reitz , Konstantin Kostiuk Content-Type: multipart/alternative; boundary="000000000000005685061bf42dae" Received-SPF: pass client-ip=170.10.133.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -22 X-Spam_score: -2.3 X-Spam_bar: -- X-Spam_report: (-2.3 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.206, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 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 --000000000000005685061bf42dae Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable On Fri, Jun 28, 2024, 3:29=E2=80=AFAM Markus Armbruster = wrote: > John Snow writes: > > > In a forthcoming series that adds a new QMP documentation generator, it > > will be helpful to have a linting baseline. However, there's no need to > > shuffle around the deck chairs too much, because most of this code will > > be removed once that new qapidoc generator (the "transmogrifier") is in > > place. > > > > To ease my pain: just turn off the black auto-formatter for most, but > > not all, of qapidoc.py. This will help ensure that *new* code follows a > > coding standard without bothering too much with cleaning up the existin= g > > code. > > > > Code that I intend to keep is still subject to the delinting beam. > > > > Signed-off-by: John Snow > > Reviewed-by: Markus Armbruster > > Not an objection, just so you know: I still see a few C0411 like 'third > party import "import sphinx" should be placed before ...' > > R-by stands. > Yeah, I think it depends on precisely where you run the script. I think because the folder is named "sphinx" that it confuses the tools in certain contexts. I'm not worried about it because we don't have an enforcement paradigm yet - I stick to my little self-test script just to make sure I'm being self-consistent, but I figured I'd worry about broader compatibility later when I reshuffle the deck chairs for qapi. --000000000000005685061bf42dae Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable


On Fri, Jun 28, 2024, 3:29=E2=80=AFAM Markus Armbruste= r <armbru@redhat.com> wrote:=
John Snow <jsnow@redhat.com&g= t; writes:

> In a forthcoming series that adds a new QMP documentation generator, i= t
> will be helpful to have a linting baseline. However, there's no ne= ed to
> shuffle around the deck chairs too much, because most of this code wil= l
> be removed once that new qapidoc generator (the "transmogrifier&q= uot;) is in
> place.
>
> To ease my pain: just turn off the black auto-formatter for most, but<= br> > not all, of qapidoc.py. This will help ensure that *new* code follows = a
> coding standard without bothering too much with cleaning up the existi= ng
> code.
>
> Code that I intend to keep is still subject to the delinting beam.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> Reviewed-by: Markus Armbruster <armbru@redhat.com>

Not an objection, just so you know: I still see a few C0411 like 'third=
party import "import sphinx" should be placed before ...'

R-by stands.

Yeah, I think it depends on precisely where you run the script.= I think because the folder is named "sphinx" that it confuses th= e tools in certain contexts.

I'm not worried about it because we don't have an enforcement = paradigm yet - I stick to my little self-test script just to make sure I= 9;m being self-consistent, but I figured I'd worry about broader compat= ibility later when I reshuffle the deck chairs for qapi.


--000000000000005685061bf42dae--