{"id":2052220,"url":"http://patchwork.ozlabs.org/api/patches/2052220/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20250226102842.3721046-5-armbru@redhat.com/","project":{"id":14,"url":"http://patchwork.ozlabs.org/api/projects/14/?format=json","name":"QEMU Development","link_name":"qemu-devel","list_id":"qemu-devel.nongnu.org","list_email":"qemu-devel@nongnu.org","web_url":"","scm_url":"","webscm_url":"","list_archive_url":"","list_archive_url_format":"","commit_url_format":""},"msgid":"<20250226102842.3721046-5-armbru@redhat.com>","list_archive_url":null,"date":"2025-02-26T10:28:40","name":"[PULL,4/6] docs/qapidoc: support header-less freeform sections","commit_ref":null,"pull_url":null,"state":"new","archived":false,"hash":"e87ec213d512bf41d097f4afb29c823ed33042f6","submitter":{"id":2645,"url":"http://patchwork.ozlabs.org/api/people/2645/?format=json","name":"Markus Armbruster","email":"armbru@redhat.com"},"delegate":null,"mbox":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20250226102842.3721046-5-armbru@redhat.com/mbox/","series":[{"id":446100,"url":"http://patchwork.ozlabs.org/api/series/446100/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/list/?series=446100","date":"2025-02-26T10:28:36","name":"[PULL,1/6] qapi/char.json: minor doc rewording for `hub` device","version":1,"mbox":"http://patchwork.ozlabs.org/series/446100/mbox/"}],"comments":"http://patchwork.ozlabs.org/api/patches/2052220/comments/","check":"pending","checks":"http://patchwork.ozlabs.org/api/patches/2052220/checks/","tags":{},"related":[],"headers":{"Return-Path":"","X-Original-To":"incoming@patchwork.ozlabs.org","Delivered-To":"patchwork-incoming@legolas.ozlabs.org","Authentication-Results":["legolas.ozlabs.org;\n\tdkim=pass (1024-bit key;\n unprotected) header.d=redhat.com header.i=@redhat.com header.a=rsa-sha256\n header.s=mimecast20190719 header.b=fsV/cJyN;\n\tdkim-atps=neutral","legolas.ozlabs.org;\n spf=pass (sender SPF authorized) smtp.mailfrom=nongnu.org\n (client-ip=209.51.188.17; helo=lists.gnu.org;\n envelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org;\n receiver=patchwork.ozlabs.org)"],"Received":["from lists.gnu.org (lists.gnu.org [209.51.188.17])\n\t(using TLSv1.2 with cipher ECDHE-ECDSA-AES256-GCM-SHA384 (256/256 bits))\n\t(No client certificate requested)\n\tby legolas.ozlabs.org (Postfix) with ESMTPS id 4Z2rMQ5bYFz1yD2\n\tfor ; Wed, 26 Feb 2025 21:30:10 +1100 (AEDT)","from localhost ([::1] helo=lists1p.gnu.org)\n\tby lists.gnu.org with esmtp (Exim 4.90_1)\n\t(envelope-from )\n\tid 1tnEev-0004Ge-Lu; Wed, 26 Feb 2025 05:28:57 -0500","from eggs.gnu.org ([2001:470:142:3::10])\n by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)\n (Exim 4.90_1) (envelope-from ) id 1tnEeu-0004FT-3B\n for qemu-devel@nongnu.org; Wed, 26 Feb 2025 05:28:56 -0500","from us-smtp-delivery-124.mimecast.com ([170.10.129.124])\n by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)\n (Exim 4.90_1) (envelope-from ) id 1tnEeq-0003fq-Ks\n for qemu-devel@nongnu.org; Wed, 26 Feb 2025 05:28:55 -0500","from mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com\n (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by\n relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3,\n cipher=TLS_AES_256_GCM_SHA384) id us-mta-205-jbhY6Ro1Pg6KJKKLzbUT0A-1; Wed,\n 26 Feb 2025 05:28:47 -0500","from mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com\n (mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.111])\n (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)\n key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest\n SHA256)\n (No client certificate requested)\n by mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS\n id 85E0818E6952\n for ; Wed, 26 Feb 2025 10:28:46 +0000 (UTC)","from blackfin.pond.sub.org (unknown [10.45.242.9])\n by mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with\n ESMTPS\n id 1772B1800946\n for ; Wed, 26 Feb 2025 10:28:45 +0000 (UTC)","by blackfin.pond.sub.org (Postfix, from userid 1000)\n id 9B74221E65EA; Wed, 26 Feb 2025 11:28:42 +0100 (CET)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;\n s=mimecast20190719; t=1740565729;\n h=from:from:reply-to:subject:subject:date:date:message-id:message-id:\n to:to:cc:cc:mime-version:mime-version:\n content-transfer-encoding:content-transfer-encoding:\n in-reply-to:in-reply-to:references:references;\n bh=+sEz+qKlhBfhwTwh2XVESCntzWnD9G5DdJ/8arWYldE=;\n b=fsV/cJyNAGZnJ1vFG8Z9R15jo+Ghp4vDwHTAjL4ommM3qJzNm5tRZeq1H9VQ9aLDmJatn/\n ldP35MtHyAUKGPyfrpR1h8LEk9PDOhfPQB4/N/dujibCmixvuRD6u9u2IQxQdB0iuDcD1N\n vAHPufp9YsxU1MF6vH8rvHMFtkZN7yY=","X-MC-Unique":"jbhY6Ro1Pg6KJKKLzbUT0A-1","X-Mimecast-MFC-AGG-ID":"jbhY6Ro1Pg6KJKKLzbUT0A_1740565726","From":"Markus Armbruster ","To":"qemu-devel@nongnu.org","Cc":"stefanha@redhat.com,\n\tJohn Snow ","Subject":"[PULL 4/6] docs/qapidoc: support header-less freeform sections","Date":"Wed, 26 Feb 2025 11:28:40 +0100","Message-ID":"<20250226102842.3721046-5-armbru@redhat.com>","In-Reply-To":"<20250226102842.3721046-1-armbru@redhat.com>","References":"<20250226102842.3721046-1-armbru@redhat.com>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","X-Scanned-By":"MIMEDefang 3.4.1 on 10.30.177.111","Received-SPF":"pass client-ip=170.10.129.124; envelope-from=armbru@redhat.com;\n helo=us-smtp-delivery-124.mimecast.com","X-Spam_score_int":"-24","X-Spam_score":"-2.5","X-Spam_bar":"--","X-Spam_report":"(-2.5 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.443,\n DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1,\n RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H5=0.001, RCVD_IN_MSPIKE_WL=0.001,\n RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001,\n RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001,\n 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":",\n ","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n ","Errors-To":"qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org","Sender":"qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org"},"content":"From: John Snow \n\nThe code as written crashes when a free-form documentation block doesn't\nstart with a heading or subheading, for example:\n\n| ##\n| # Just text, no heading.\n| ##\n\nThe code will attempt to use the `node` variable uninitialized. To fix,\ncreate a generic block to insert the doc text into.\n\n(This patch also removes a lingering pylint warning in the QAPIDoc\nimplementation that prevents getting a clean baseline to use for\nforthcoming additions.)\n\nFixes: 43e0d14ee09a (docs/sphinx: fix extra stuff in TOC after freeform QMP sections)\nSigned-off-by: John Snow \nMessage-ID: <20250224033741.222749-5-jsnow@redhat.com>\nReviewed-by: Markus Armbruster \n[Test updated to cover this]\nSigned-off-by: Markus Armbruster \n---\n docs/sphinx/qapidoc.py | 2 ++\n tests/qapi-schema/doc-good.json | 4 ++++\n tests/qapi-schema/doc-good.out | 3 +++\n 3 files changed, 9 insertions(+)","diff":"diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py\nindex 5f96b46270..5a4d7388b2 100644\n--- a/docs/sphinx/qapidoc.py\n+++ b/docs/sphinx/qapidoc.py\n@@ -421,6 +421,8 @@ def freeform(self, doc):\n node = self._start_new_heading(heading, len(leader))\n if text == '':\n return\n+ else:\n+ node = nodes.container()\n \n self._parse_text_into_node(text, node)\n self._cur_doc = None\ndiff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json\nindex f64bf38d85..0a4f139f83 100644\n--- a/tests/qapi-schema/doc-good.json\n+++ b/tests/qapi-schema/doc-good.json\n@@ -11,6 +11,10 @@\n # = Section\n ##\n \n+##\n+# Just text, no heading.\n+##\n+\n ##\n # == Subsection\n #\ndiff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out\nindex ec277be91e..0a9da3efde 100644\n--- a/tests/qapi-schema/doc-good.out\n+++ b/tests/qapi-schema/doc-good.out\n@@ -56,6 +56,9 @@ event EVT_BOXED Object\n doc freeform\n body=\n = Section\n+doc freeform\n+ body=\n+Just text, no heading.\n doc freeform\n body=\n == Subsection\n","prefixes":["PULL","4/6"]}