From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-13.6 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id A0682C433ED for ; Tue, 6 Apr 2021 13:34:53 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 22A02613B7 for ; Tue, 6 Apr 2021 13:34:53 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 22A02613B7 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([::1]:43314 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lTlr2-0003Vu-7O for qemu-devel@archiver.kernel.org; Tue, 06 Apr 2021 09:34:52 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:55468) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lTlqF-00035k-6b for qemu-devel@nongnu.org; Tue, 06 Apr 2021 09:34:03 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:31216) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lTlqA-00043t-45 for qemu-devel@nongnu.org; Tue, 06 Apr 2021 09:34:02 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1617716037; 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=9MUZKNhYKuUAS2y5O/s5ysx1yl4uTxh/QEWeP0/76D0=; b=I6usdVTkXnlmxXB/7PouUCCHe4b7SxRjbNrMcTDk5qd25AvsOXb6GRRP+n6Rjm2MnAQxLE FwMTbhxgWZPuMIj7I+3lavnDBKU5T2SDs0fl9CtcKUhxnSq8s4WaV+0l2ShswRI4kL4Qqg Ok45KrblRAt/K9Pou//ToRVeuTkqoS4= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-39-xiuKW16QMvSyXgi1NKpC8g-1; Tue, 06 Apr 2021 09:33:55 -0400 X-MC-Unique: xiuKW16QMvSyXgi1NKpC8g-1 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id F2DCE5B365; Tue, 6 Apr 2021 13:33:53 +0000 (UTC) Received: from blackfin.pond.sub.org (ovpn-114-17.ams2.redhat.com [10.36.114.17]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 2983160937; Tue, 6 Apr 2021 13:33:51 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 9ADF2113865F; Tue, 6 Apr 2021 15:33:39 +0200 (CEST) From: Markus Armbruster To: John Snow Subject: Re: docs/qemu-qmp-ref.7 markup messed up References: <87v99engjp.fsf@dusky.pond.sub.org> Date: Tue, 06 Apr 2021 15:33:39 +0200 In-Reply-To: (John Snow's message of "Fri, 26 Mar 2021 16:40:31 -0400") Message-ID: <87blar7d1o.fsf@dusky.pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.1 (gnu/linux) MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=armbru@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain Received-SPF: pass client-ip=216.205.24.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, 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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Peter Maydell , Markus Armbruster , QEMU Developers Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" John Snow writes: > On 3/26/21 10:19 AM, Markus Armbruster wrote: >> When I look at docs/qemu-qmp-ref.7 with less -R, I see >> ReplicationMode (Enum) >> An enumeration of replication modes. >> Values >> primary >> Primary mode, the vm's state will be sent to secondary QEMU. >> secondary >> Secondary mode, receive the vm's state from primary QEMU. >> Since >> 2.9 >> If >> --> defined(CONFIG_REPLICATION).SS BlockdevOptionsReplication (Object) >> Driver specific block device options for replication >> Members >> mode: ReplicationMode >> the replication mode >> The line I marked with --> is bad. It should instead look like >> If >> defined(CONFIG_REPLICATION) >> BlockdevOptionsReplication (Object) >> Driver specific block device options for replication >> Unformatted code: >> .SS \fBReplicationMode\fP (Enum) >> .sp >> An enumeration of replication modes. >> .SS Values >> .INDENT 0.0 >> .TP >> .B \fBprimary\fP >> Primary mode, the vm\(aqs state will be sent to secondary QEMU. >> .TP >> .B \fBsecondary\fP >> Secondary mode, receive the vm\(aqs state from primary QEMU. >> .UNINDENT >> .SS Since >> .sp >> 2.9 >> .SS If >> --> \fBdefined(CONFIG_REPLICATION)\fP.SS \fBBlockdevOptionsReplication\fP (Object) >> .sp >> Driver specific block device options for replication >> .SS Members >> .INDENT 0.0 >> .TP >> .B \fBmode\fP: \fBReplicationMode\fP >> the replication mode >> .TP >> I believe line I marked with --> should be broken before .SS. >> I'm using sphinx-build-3 2.2.2. >> I checked with the merge commit that switched QAPI doc generation to >> Sphinx (commit e344ffe73b), same result. >> > > It looks like that's consistent for every case I can see for > "defined(...)", where the .SS bit comes immediately on the same line. > > _nodes_for_if_section seems to handle the docutil tree creation for > the stuff in question, here, I think? > > I changed the heading to "IfZ" to make it nicer to grep, and then If I > pepper in some prints (mercifully docutils has very nice __str__ > methods!) I can see this type of stuff: > >
ids="qapidoc-713">IfZdefined(CONFIG_REPLICATION)
>
ids="qapidoc-717">IfZdefined(CONFIG_REPLICATION)
> > Hm, I think is not a block-level element, and maybe there's > a bug/intentional-design-choice/bug where it can't handle a non-block > child of a section correctly? > > Let me try wrapping it in a PARAGRAPH node... > > .SS IfZ > .sp > \fBdefined(CONFIG_REPLICATION)\fP > .SS \fBBlockdevOptionsReplication\fP (Object) > .sp > > > That looks better, I think. > > > diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py > index b7b86b5dff..b7a2d39c10 100644 > --- a/docs/sphinx/qapidoc.py > +++ b/docs/sphinx/qapidoc.py > @@ -278,7 +278,9 @@ def _nodes_for_if_section(self, ifcond): > nodelist = [] > if ifcond: > snode = self._make_section('If') > - snode += self._nodes_for_ifcond(ifcond, with_if=False) > + snode += nodes.paragraph( > + '', '', *self._nodes_for_ifcond(ifcond, with_if=False) > + ) > nodelist.append(snode) > return nodelist > > > Signed-off-by: John Snow > > --js Fixes the issue for me, thanks! Tested-by: Markus Armbruster Please post as a proper patch.