From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 63EB244AB81 for ; Mon, 31 Aug 2026 14:27:14 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=170.10.129.124 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1788186436; cv=none; b=HEKy4WEobaZMEDtDpC/ETNBHzo0QmZ8UgpWIMzOWWvxEMZvSxPPQyHanNggxOXNmkDjVj9c6M7yxLr6EH2GA8AQ9nADcjg+r4v+Xb8BBL7kXCuepd9KKDTgy5p8sur1pJ/6phBPkeT1Y4eyRR8wfogWtRRT+ChTlVH5JEgkjr8Q= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1788186436; c=relaxed/simple; bh=4wZqQyFq1qdVFPr/8CRkP8i0ygfeBygDfw6Ts6Gc1mM=; h=From:To:Cc:Subject:In-Reply-To:References:Date:Message-ID: MIME-Version:Content-Type; b=M1/dRIo/2znSbVWCJnAv/19N/GCjgW114Rw9pWnruXChec9Az4ZJWqsHJpSdZxIYgAxgU6ADiI53M2TbKjl0DsLL3wS0zotbTVXnv8inFy+E3UHazaVUe/go5IDZ6GXUYzkjo1PT3BFUis0g34c6IHCs79nZIl6exXTBd7PceX4= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=redhat.com; spf=pass smtp.mailfrom=redhat.com; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b=Y/A6TocR; arc=none smtp.client-ip=170.10.129.124 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=redhat.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=redhat.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="Y/A6TocR" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1788186433; 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=HCozuPAg1cr/zk+7RZYGGy+oIIzMfSunUSVRYIRDg+0=; b=Y/A6TocRJSV6EsCXZY9VaVuMWHn/etpKOwoAalthtYXhavvX4QVUwo30cSEOox7SEud5YT SBkmrPNs538tB3FNjKooXKXHao9MAp/MmkjSW1QAGHbOI7+4r2GqEcsbwJqgr9TlPfVrLl 7/uGGaeAbqK7wu4gm8w3STUylKYceuw= Received: from mx-prod-mc-06.mail-002.prod.us-west-2.aws.redhat.com (ec2-35-165-154-97.us-west-2.compute.amazonaws.com [35.165.154.97]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-9-8rxvVzleOh2OI-99uu497g-1; Mon, 31 Aug 2026 10:27:11 -0400 X-MC-Unique: 8rxvVzleOh2OI-99uu497g-1 X-Mimecast-MFC-AGG-ID: 8rxvVzleOh2OI-99uu497g_1788186428 Received: from mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.111]) (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-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 777EF187078B; Mon, 31 Aug 2026 14:27:07 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.44.22.5]) by mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 9C03A18005BD; Mon, 31 Aug 2026 14:27:05 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 272D221E6832; Mon, 31 Aug 2026 16:27:03 +0200 (CEST) From: Markus Armbruster To: John Snow Cc: qemu-devel@nongnu.org, Alex Williamson , Daniel P. =?utf-8?Q?Berrang=C3=A9?= , linux-cxl@vger.kernel.org, Michael Tokarev , Vladimir Sementsov-Ogievskiy , Peter Xu , Eric Blake , =?utf-8?Q?Marc-Andr=C3=A9?= Lureau , zhenwei pi , qemu-trivial@nongnu.org, Fabiano Rosas , Kevin Wolf , Laurent Vivier , Jiri Pirko , qemu-block@nongnu.org, Stefan Hajnoczi , Stefan Berger , linux-edac@vger.kernel.org, "Gonglei (Arei)" , Igor Mammedov , Gerd Hoffmann , Jonathan Cameron , Alex =?utf-8?Q?Benn=C3=A9e?= , Zhao Liu , Mauro Carvalho Chehab , "Michael S. Tsirkin" , Hanna Reitz , Jason Wang , Richard Henderson , Paolo Bonzini , Ani Sinha , Philippe =?utf-8?Q?Mathieu-Daud=C3=A9?= , Lukas Straub , =?utf-8?Q?C=C3=A9dric?= Le Goater Subject: Re: [PATCH v3 00/43] qapi: convert (very) trivial intro sections In-Reply-To: <20260826193840.2152000-1-jsnow@redhat.com> (John Snow's message of "Wed, 26 Aug 2026 15:37:57 -0400") References: <20260826193840.2152000-1-jsnow@redhat.com> Date: Mon, 31 Aug 2026 16:27:03 +0200 Message-ID: <87pkyycqmg.fsf@pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) Precedence: bulk X-Mailing-List: linux-edac@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.111 John Snow writes: > v3: > As per Markus' request, the intro section conversion has been split > even further into the *very* trivial; leaving the semi-trivial and > not-trivial conversions for later consideration. > > If you are a non-qapi/non-docs maintainer being CC'd on this patch, > there is **very likely** nothing for you to do here; we are only > changing spacing and syntax, but not modifying content in any way > in this series in particular. Please feel free to mark-as-read and > move on with your day. > - > > Hi, this patchset converts trivial "introductory" sections in the QAPI > documentation to use the new, explicit intro section syntax. > > This is being done primarily for the benefit of the forthcoming > "inliner", a feature for the rendered HTML QMP documentation that > seeks to "inline" QMP command argument documentation into the argument > list for each command. > > There are two main motives here: > > (1) We want the split between the "introduction" and "details" > sections to be mechanically obvious, so that auto-generated or > inlined documentation has a well-defined, obvious spot to go. > > (2) We do not want to inline irrelevant, introductory text describing > structures to be copied into command documentation. > > This patchset tackles "very trivial" conversions: cases where the > existing leading plaintext is only a single sentence and is > immediately followed by a tagged section, the end of the documentation > block, or some other pre-existing syntactical delineation. (i.e.: not > more plaintext.) I checked whether the converted intros are indeed all "very trivial". Only a few that aren't have crept in. I replied to the patches. I eye-balled whether these intros actually contain only introductory text. Looks like it (but I'm only human, and the checking is t-e-d-i-o-u-s). Many of them could use polish. Not today. With the few conversions that aren't "very trivial" dropped, series Reviewed-by: Markus Armbruster > NOTE: This series *may* miss some conversions; future QAPI changes will > enforce the new syntax and any cases that have appeared since v1 will > be identified and corrected at that time; we are concerned with the > bulk and ease-of-review here, not completeness. This is precisely why > the new intro syntax and parser were carefully designed to allow > gradual conversion. Partial conversion is undesirable. We need to finish the job. We'll need more than one series to have a chance at actually reviewing it. I'm debating whether to keep them on a branch until we finish. If I count correctly, roughly 70% of all intros are "very trivial". Good to get them out of the way. > NOTE2: Future patches that may require more scrutiny will handle the > remaining conversions - There are some very subtle concerns that are > not readily apparent in the very minor textual changes that will be > spelled out for reviewers in the cover letters for those series. > > This is enough for today, don't you think? Yes!