From nobody Sat Nov 15 16:30:41 2025 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=quarantine dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1750265733; cv=none; d=zohomail.com; s=zohoarc; b=ea5QiahpLv+NF6jLRJxPka+P8KUmjfiViLJgpJylBuiQBoaURRuk/OQW1D4piwoZ4dAIbQNhJ7mRhR1/9a0hfjiJRaTPbxyn7Hba8wBQKgDZ9Q4TLSe2fkXiVXssiOzY2DkhgvzFxUVAiplXrlrPK0KQXbW5C9uhUEuNeIfiBzA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1750265733; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=XiP9jAhDIQA4ZTQPxDmAafyDqs5ys2VopT4bybWj7Yk=; b=HWS8jZVTJRnlT0Cn9HbOb3GMqTarK6eDLWHln5/4H6zhHv8i6jdsHFHItXlty2uNjIEa8QKgt2DWkBfYJ6bND3LJVWubTMuZ8syQo/4ZNSaHjUZOPH85+phCPjB2lPewFEwx8qd+XAOs5OFsjZASnDAYV2Zy7KhI71yrk593LhU= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1750265733360474.0815382470811; Wed, 18 Jun 2025 09:55:33 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1uRw3T-0006IN-At; Wed, 18 Jun 2025 12:54:33 -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 1uRw3L-0006Fn-1s for qemu-devel@nongnu.org; Wed, 18 Jun 2025 12:54:24 -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 1uRw3J-0007rD-G7 for qemu-devel@nongnu.org; Wed, 18 Jun 2025 12:54:22 -0400 Received: from mx-prod-mc-03.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-417-s6WxykgzMKmwISemSAugoA-1; Wed, 18 Jun 2025 12:54:14 -0400 Received: from mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.4]) (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-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 340EB1955F37; Wed, 18 Jun 2025 16:54:11 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.80.74]) by mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 4E14930001BD; Wed, 18 Jun 2025 16:54:04 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1750265658; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=XiP9jAhDIQA4ZTQPxDmAafyDqs5ys2VopT4bybWj7Yk=; b=YtiUggD/QsRKPqUHB+pmD7Jq9An44i7UwaIkRk31azRUt3OcljQX7ecAPqGLSc0PoCt9fP 2pWpi5sj377RM26DsW6qH54jV435Qpae1NnCumrwAqJVZwtPV1IcuapomXFMuSaD7eL5wt 9cqpNqEz2I6celVUFgb/MgnSS+cO4lc= X-MC-Unique: s6WxykgzMKmwISemSAugoA-1 X-Mimecast-MFC-AGG-ID: s6WxykgzMKmwISemSAugoA_1750265652 From: John Snow To: qemu-devel@nongnu.org Cc: Jiri Pirko , Fan Ni , Stefano Garzarella , Michael Roth , "Gonglei (Arei)" , Stefan Hajnoczi , Vladimir Sementsov-Ogievskiy , Paolo Bonzini , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , qemu-block@nongnu.org, =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Jonathan Cameron , Fabiano Rosas , Kashyap Chamarthy , "Michael S. Tsirkin" , Yanan Wang , Stefan Berger , John Snow , Igor Mammedov , Gerd Hoffmann , Hanna Reitz , Mads Ynddal , Ani Sinha , Zhao Liu , Marcel Apfelbaum , Kevin Wolf , Eric Blake , =?UTF-8?q?C=C3=A9dric=20Le=20Goater?= , Peter Xu , Cleber Rosa , Eduardo Habkost , =?UTF-8?q?Alex=20Benn=C3=A9e?= , Konstantin Kostiuk , Peter Maydell , Alex Williamson , Zhenwei Pi , Jason Wang , Lukas Straub , Markus Armbruster Subject: [PATCH v3 1/5] docs/sphinx: adjust qapidoc to cope with same-line error sections Date: Wed, 18 Jun 2025 12:53:49 -0400 Message-ID: <20250618165353.1980365-2-jsnow@redhat.com> In-Reply-To: <20250618165353.1980365-1-jsnow@redhat.com> References: <20250618165353.1980365-1-jsnow@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.4 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.129.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -39 X-Spam_score: -4.0 X-Spam_bar: ---- X-Spam_report: (-4.0 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-1.895, 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_H5=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=unavailable 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+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1750265740367116600 Content-Type: text/plain; charset="utf-8" Signed-off-by: John Snow --- docs/sphinx/qapidoc.py | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py index 8011ac9efaf..5374dee8fad 100644 --- a/docs/sphinx/qapidoc.py +++ b/docs/sphinx/qapidoc.py @@ -267,10 +267,14 @@ def visit_returns(self, section: QAPIDoc.Section) -> = None: self.add_field("return", typ, section.text, section.info) =20 def visit_errors(self, section: QAPIDoc.Section) -> None: - # FIXME: the formatting for errors may be inconsistent and may - # or may not require different newline placement to ensure - # proper rendering as a nested list. - self.add_lines(f":error:\n{section.text}", section.info) + # If the section text does not start with a space, it means text + # began on the same line as the "Error:" string and we should + # not insert a newline in this case. + if section.text[0].isspace(): + text =3D f":error:\n{section.text}" + else: + text =3D f":error: {section.text}" + self.add_lines(text, section.info) =20 def preamble(self, ent: QAPISchemaDefinition) -> None: """ --=20 2.48.1