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 24D4FC3064D for ; Wed, 26 Jun 2024 05:36:36 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sMLJj-0003yL-T1; Wed, 26 Jun 2024 01:35:39 -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 1sMLJh-0003u3-Qe for qemu-devel@nongnu.org; Wed, 26 Jun 2024 01:35:37 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sMLJg-0002xD-0A for qemu-devel@nongnu.org; Wed, 26 Jun 2024 01:35:37 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1719380134; 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=vffNxjF5daUXM6iOZysxEbPY/FXIAEA829TT5HJDBSw=; b=jM/Gc/fCoDdXEWTlBylDMSK1mPwXX0miGVuQFOfnAvbFehaOMu7SCR//1wECobgnyX0rxn aJHszPrXv5Ecx6LnKds1REXHtdo3fum/m1WFXrshlSgPrkmcaQ+doeAg44UMdkZ24YJZWz uHPlsTfl/BJcYRwzXtZupfOx3wNmPuw= Received: from mx-prod-mc-04.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-433--LToLLKFPMara8je_ohTzA-1; Wed, 26 Jun 2024 01:35:30 -0400 X-MC-Unique: -LToLLKFPMara8je_ohTzA-1 Received: from mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.15]) (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-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 3B29C19560B5; Wed, 26 Jun 2024 05:35:28 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.93]) by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 3D5471955E82; Wed, 26 Jun 2024 05:35:26 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 040F321E6687; Wed, 26 Jun 2024 07:35:24 +0200 (CEST) From: Markus Armbruster To: John Snow Cc: qemu-devel@nongnu.org, Stefan Hajnoczi , Hanna Reitz , Michael Roth , Philippe =?utf-8?Q?Mathieu-Daud=C3=A9?= , Victor Toso de Carvalho , "Michael S. Tsirkin" , Konstantin Kostiuk , Yanan Wang , Pavel Dovgalyuk , =?utf-8?Q?Marc-Andr=C3=A9?= Lureau , Marcel Apfelbaum , Fabiano Rosas , Lukas Straub , Eduardo Habkost , Mads Ynddal , Daniel P. =?utf-8?Q?Berrang=C3=A9?= , Gerd Hoffmann , Peter Xu , Igor Mammedov , =?utf-8?Q?C=C3=A9dric?= Le Goater , Jason Wang , Ani Sinha , Paolo Bonzini , Peter Maydell , qemu-block@nongnu.org, Jiri Pirko , Alex Williamson , Kevin Wolf , Eric Blake Subject: Re: [PATCH 00/13] qapi: convert "Note" and "Example" sections to rST In-Reply-To: <20240619003012.1753577-1-jsnow@redhat.com> (John Snow's message of "Tue, 18 Jun 2024 20:29:59 -0400") References: <20240619003012.1753577-1-jsnow@redhat.com> Date: Wed, 26 Jun 2024 07:35:23 +0200 Message-ID: <87tthguuzo.fsf@pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain X-Scanned-By: MIMEDefang 3.0 on 10.30.177.15 Received-SPF: pass client-ip=170.10.129.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: 11 X-Spam_score: 1.1 X-Spam_bar: + X-Spam_report: (1.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.151, 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_SBL_CSS=3.335, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no 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 You asked for a summary of my review findings. Here it is: * PATCH 01: DO-NOT-MERGE, not reviewed * PATCH 02, 05..07, 10..12: R-by or A-by * PATCH 03: R-by with straightforward minor adjustments * PATCH 04, 08: R-by with commit message and doc tweaks * PATCH 09: - Commit message tweaks - You convert "Note:" even in free-form doc, where it isn't recognized; separate patch or mention in commit message - You silently move one note; don't, separate patch, or mention in commit message - Tweak doc-interleaved-section.json - A few more notes need to start with a capital letter and / or end with a period - I don't like the indentation change * PATCH 12: Want a positive test * PATCH 13: - One hunk should be squashed into PATCH 09 - Accidentally duplicated example should be dropped - You convert "Example:" even in free-form doc, where it isn't recognized; separate patch or mention in commit message - Sphinx doesn't recognize a .. code-block: directive in doc-good.json - doc-good.txt loses "Example" - Generated HTML looks somehwat ugly Feel free to leave reverting indentation changes to me. Same for starting notes with a capital letter and ending them with a period. I'm willing to accept ugly HTML along with a promise of future improvement :)