{"id":2052217,"url":"http://patchwork.ozlabs.org/api/patches/2052217/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20250226102842.3721046-6-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-6-armbru@redhat.com>","list_archive_url":null,"date":"2025-02-26T10:28:41","name":"[PULL,5/6] docs/qapidoc: remove example section support","commit_ref":null,"pull_url":null,"state":"new","archived":false,"hash":"2bdf3ad83cc3d90129bf9af6ab22ee91b26fbdc0","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-6-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/2052217/comments/","check":"pending","checks":"http://patchwork.ozlabs.org/api/patches/2052217/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=HOhokfow;\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 4Z2rM248sjz1yD2\n\tfor ; Wed, 26 Feb 2025 21:29:49 +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 1tnEex-0004HI-9v; Wed, 26 Feb 2025 05:28:59 -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-0004Fd-8y\n for qemu-devel@nongnu.org; Wed, 26 Feb 2025 05:28:56 -0500","from us-smtp-delivery-124.mimecast.com ([170.10.133.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 1tnEes-0003gD-Ho\n for qemu-devel@nongnu.org; Wed, 26 Feb 2025 05:28:55 -0500","from mx-prod-mc-06.mail-002.prod.us-west-2.aws.redhat.com\n (ec2-35-165-154-97.us-west-2.compute.amazonaws.com [35.165.154.97]) by\n relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3,\n cipher=TLS_AES_256_GCM_SHA384) id us-mta-686-5tNp8bw3OTKKNrXlu7rkdA-1; Wed,\n 26 Feb 2025 05:28:50 -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-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS\n id B04841800268\n for ; Wed, 26 Feb 2025 10:28:49 +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 69E31180087F\n for ; Wed, 26 Feb 2025 10:28:48 +0000 (UTC)","by blackfin.pond.sub.org (Postfix, from userid 1000)\n id 9F43321E65FD; 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=1740565733;\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=J63+xeMvDp8oP/T4oQACy9QBFnsjVacP1Jp692/Nx7o=;\n b=HOhokfowgzhVtDNeRad9kQcRGGrC1oeA5NqGH9u6loqQNyVWUHkbb4fW6DtMMRF+KjL8f8\n naqPb0JDzvkTw6h5Efm9Fcq/Je9zOvmeuV7IdSgyoDzk0vuW4sJw4Nevsy1S8eyld8U/VO\n GOFLXeSYzle0DSaxsEFvaH1GPURk5CY=","X-MC-Unique":"5tNp8bw3OTKKNrXlu7rkdA-1","X-Mimecast-MFC-AGG-ID":"5tNp8bw3OTKKNrXlu7rkdA_1740565729","From":"Markus Armbruster ","To":"qemu-devel@nongnu.org","Cc":"stefanha@redhat.com,\n\tJohn Snow ","Subject":"[PULL 5/6] docs/qapidoc: remove example section support","Date":"Wed, 26 Feb 2025 11:28:41 +0100","Message-ID":"<20250226102842.3721046-6-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.133.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_H2=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\nSince commit 3c5f6114 (qapi: remove \"Example\" doc section), Example\nsections no longer exist, so this support in qapidoc is now dead code.\n\nSigned-off-by: John Snow \nMessage-ID: <20250224033741.222749-7-jsnow@redhat.com>\nReviewed-by: Markus Armbruster \nSigned-off-by: Markus Armbruster \n---\n docs/sphinx/qapidoc.py | 9 +--------\n 1 file changed, 1 insertion(+), 8 deletions(-)","diff":"diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py\nindex 5a4d7388b2..61997fd21a 100644\n--- a/docs/sphinx/qapidoc.py\n+++ b/docs/sphinx/qapidoc.py\n@@ -254,10 +254,6 @@ def _nodes_for_features(self, doc):\n section += dlnode\n return [section]\n \n- def _nodes_for_example(self, exampletext):\n- \"\"\"Return list of doctree nodes for a code example snippet\"\"\"\n- return [nodes.literal_block(exampletext, exampletext)]\n-\n def _nodes_for_sections(self, doc):\n \"\"\"Return list of doctree nodes for additional sections\"\"\"\n nodelist = []\n@@ -275,10 +271,7 @@ def _nodes_for_sections(self, doc):\n continue\n \n snode = self._make_section(section.tag)\n- if section.tag.startswith('Example'):\n- snode += self._nodes_for_example(dedent(section.text))\n- else:\n- self._parse_text_into_node(dedent(section.text), snode)\n+ self._parse_text_into_node(dedent(section.text), snode)\n nodelist.append(snode)\n return nodelist\n \n","prefixes":["PULL","5/6"]}