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 5DA5B389114 for ; Mon, 31 Aug 2026 20:20:09 +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=1788207611; cv=none; b=iXkLfQkpq8a+61noAUW8GlJGVa5R+aGXhJxDbRp+vv8bIgQlN1CCypCz35b8Cd20JG/xETYUrDjbR9ta+CABOsVjQE9MhdwbE8raRDa7VcBGNSH77Mb64eCw/Gs5ofoKVUWYMZEbn3GS4AM+mb/h2DxkciK2DyPtUje/iwx+jyk= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1788207611; c=relaxed/simple; bh=BxA1N27cdp0YzUP6BKGxFLNMDD5S8nNGwrc9GD5SKWw=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version:Content-Type; b=ajBsX3xPmTjymCKpLrx+hJRDEZL2ze575JV+w0Jh44YDm6n4j1IX6NPuDEodDh5nXQnWJRMr9SHO8aMuu3XUjLuX4/IH5oglk34Fagpnrv9kLphXQJvH4pPuceZBQNL2aFQDFvPlSKk8SYISiBSw/KL5nSrmR2DtjkOrfRObAHI= 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=SSNjx8Ug; 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="SSNjx8Ug" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1788207608; 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; bh=VTKbCZqJIq+C9hQ9iubao4nwFmrh6uAcc4E13Ha33cg=; b=SSNjx8Ugy2snmUsVzHJ8JlYWd0KoNtwm5wcULwGzPxWkydl2iv4uvzg+sQ0kAaP2MP9Ted iwtxCozIjxRYgflx7dWnVBagZVg6L7X/AH3quUF2++oR1xvjkqBnOIkiR/dWSWpRCqqxjS XK5ZjXrz/keBmG6zkisCV0QFjGdiFqE= Received: from mx-prod-mc-08.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-271-wHjEGSbwPwid_ycwm4CqUQ-1; Mon, 31 Aug 2026 16:20:04 -0400 X-MC-Unique: wHjEGSbwPwid_ycwm4CqUQ-1 X-Mimecast-MFC-AGG-ID: wHjEGSbwPwid_ycwm4CqUQ_1788207601 Received: from mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.93]) (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-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 012BE184BAB6; Mon, 31 Aug 2026 20:19:58 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.88.63]) by mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 547631800577; Mon, 31 Aug 2026 20:19:47 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org Cc: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Lukas Straub , =?UTF-8?q?Alex=20Benn=C3=A9e?= , Richard Henderson , zhenwei pi , Jonathan Cameron , Paolo Bonzini , Stefan Hajnoczi , Markus Armbruster , Vladimir Sementsov-Ogievskiy , Jiri Pirko , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , qemu-block@nongnu.org, Ani Sinha , Jason Wang , linux-cxl@vger.kernel.org, =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Igor Mammedov , Hanna Reitz , Alex Williamson , Stefan Berger , "Michael S. Tsirkin" , Laurent Vivier , linux-edac@vger.kernel.org, Michael Tokarev , John Snow , Fabiano Rosas , Zhao Liu , "Gonglei (Arei)" , Eric Blake , Peter Xu , Gerd Hoffmann , Kevin Wolf , Mauro Carvalho Chehab , qemu-trivial@nongnu.org, =?UTF-8?q?C=C3=A9dric=20Le=20Goater?= Subject: [PATCH v4 00/43] qapi: convert (very) trivial intro sections Date: Mon, 31 Aug 2026 16:19:02 -0400 Message-ID: <20260831201945.287730-1-jsnow@redhat.com> Precedence: bulk X-Mailing-List: linux-edac@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.93 v4:=0D - Added r-b's from various folks=0D - Dropped a few conversion cases that were just simply not trivial enough.= =0D =0D If you are a non-qapi/non-docs maintainer being CC'd on this patch,=0D there is **very likely** nothing for you to do here; we are only=0D changing spacing and syntax, but not modifying content in any way=0D in this series in particular. Please feel free to mark-as-read and=0D move on with your day.=0D =0D v3:=0D As per Markus' request, the intro section conversion has been split=0D even further into the *very* trivial; leaving the semi-trivial and=0D not-trivial conversions for later consideration.=0D =0D -=0D =0D Hi, this patchset converts trivial "introductory" sections in the QAPI=0D documentation to use the new, explicit intro section syntax.=0D =0D This is being done primarily for the benefit of the forthcoming=0D "inliner", a feature for the rendered HTML QMP documentation that=0D seeks to "inline" QMP command argument documentation into the argument=0D list for each command.=0D =0D There are two main motives here:=0D =0D (1) We want the split between the "introduction" and "details"=0D sections to be mechanically obvious, so that auto-generated or=0D inlined documentation has a well-defined, obvious spot to go.=0D =0D (2) We do not want to inline irrelevant, introductory text describing=0D structures to be copied into command documentation.=0D =0D This patchset tackles "very trivial" conversions: cases where the=0D existing leading plaintext is only a single sentence and is=0D immediately followed by a tagged section, the end of the documentation=0D block, or some other pre-existing syntactical delineation. (i.e.: not=0D more plaintext.)=0D =0D NOTE: This series *may* miss some conversions; future QAPI changes will=0D enforce the new syntax and any cases that have appeared since v1 will=0D be identified and corrected at that time; we are concerned with the=0D bulk and ease-of-review here, not completeness. This is precisely why=0D the new intro syntax and parser were carefully designed to allow=0D gradual conversion.=0D =0D NOTE2: Future patches that may require more scrutiny will handle the=0D remaining conversions - There are some very subtle concerns that are=0D not readily apparent in the very minor textual changes that will be=0D spelled out for reviewers in the cover letters for those series.=0D =0D This is enough for today, don't you think?=0D =0D John Snow (43):=0D qapi: convert trivial intro sections for error.json=0D qapi: convert trivial intro sections for acpi-hest.json=0D qapi: convert trivial intro sections for ebpf.json=0D qapi: convert trivial intro sections for compat.json=0D qapi: convert trivial intro sections for vfio.json=0D qapi: convert trivial intro sections for trace.json=0D qapi: convert trivial intro sections for misc-arm.json=0D qapi: convert trivial intro sections for cryptodev.json=0D qapi: convert trivial intro sections for machine-common.json=0D qapi: convert trivial intro sections for accelerator.json=0D qapi: convert trivial intro sections for authz.json=0D qapi: convert trivial intro sections for yank.json=0D qapi: convert trivial intro sections for replay.json=0D qapi: convert trivial intro sections for machine-s390x.json=0D qapi: convert trivial intro sections for acpi.json=0D qapi: convert trivial intro sections for tpm.json=0D qapi: convert trivial intro sections for qdev.json=0D qapi: convert trivial intro sections for control.json=0D qapi: convert trivial intro sections for dump.json=0D qapi: convert trivial intro sections for common.json=0D qapi: convert trivial intro sections for sockets.json=0D qapi: convert trivial intro sections for transaction.json=0D qapi: convert trivial intro sections for stats.json=0D qapi: convert trivial intro sections for job.json=0D qapi: convert trivial intro sections for pci.json=0D qapi: convert trivial intro sections for introspect.json=0D qapi: convert trivial intro sections for rocker.json=0D qapi: convert trivial intro sections for misc-i386.json=0D qapi: convert trivial intro sections for block-export.json=0D qapi: convert trivial intro sections for audio.json=0D qapi: convert trivial intro sections for block.json=0D qapi: convert trivial intro sections for misc.json=0D qapi: convert trivial intro sections for crypto.json=0D qapi: convert trivial intro sections for cxl.json=0D qapi: convert trivial intro sections for run-state.json=0D qapi: convert trivial intro sections for char.json=0D qapi: convert trivial intro sections for virtio.json=0D qapi: convert trivial intro sections for net.json=0D qapi: convert trivial intro sections for qom.json=0D qapi: convert trivial intro sections for ui.json=0D qapi: convert trivial intro sections for migration.json=0D qapi: convert trivial intro sections for machine.json=0D qapi: convert trivial intro sections for block-core.json=0D =0D qapi/accelerator.json | 18 +-=0D qapi/acpi-hest.json | 4 +-=0D qapi/acpi.json | 8 +-=0D qapi/audio.json | 88 +++-----=0D qapi/authz.json | 21 +-=0D qapi/block-core.json | 431 ++++++++++++++-------------------------=0D qapi/block-export.json | 50 ++---=0D qapi/block.json | 41 ++--=0D qapi/char.json | 90 +++-----=0D qapi/common.json | 29 +--=0D qapi/compat.json | 6 +-=0D qapi/control.json | 30 +--=0D qapi/crypto.json | 100 ++++-----=0D qapi/cryptodev.json | 18 +-=0D qapi/cxl.json | 6 +-=0D qapi/dump.json | 19 +-=0D qapi/ebpf.json | 6 +-=0D qapi/error.json | 3 +-=0D qapi/introspect.json | 40 ++--=0D qapi/job.json | 18 +-=0D qapi/machine-common.json | 14 +-=0D qapi/machine-s390x.json | 13 +-=0D qapi/machine.json | 195 ++++++------------=0D qapi/migration.json | 131 +++++-------=0D qapi/misc-arm.json | 6 +-=0D qapi/misc-i386.json | 52 ++---=0D qapi/misc.json | 74 +++----=0D qapi/net.json | 92 +++------=0D qapi/pci.json | 27 +--=0D qapi/qdev.json | 14 +-=0D qapi/qom.json | 150 +++++---------=0D qapi/replay.json | 6 +-=0D qapi/rocker.json | 39 ++--=0D qapi/run-state.json | 113 ++++------=0D qapi/sockets.json | 31 ++-=0D qapi/stats.json | 34 ++-=0D qapi/tpm.json | 29 +--=0D qapi/trace.json | 12 +-=0D qapi/transaction.json | 14 +-=0D qapi/ui.json | 199 ++++++------------=0D qapi/vfio.json | 4 +-=0D qapi/virtio.json | 54 ++---=0D qapi/yank.json | 5 +-=0D 43 files changed, 833 insertions(+), 1501 deletions(-)=0D =0D -- =0D 2.55.0=0D =0D