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 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 smtp.lore.kernel.org (Postfix) with ESMTPS id 6C8A8C48BC3 for ; Tue, 20 Feb 2024 15:18:58 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rcRtT-0006mA-Fe; Tue, 20 Feb 2024 10:18:51 -0500 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 1rcRtI-0006bP-6l for qemu-devel@nongnu.org; Tue, 20 Feb 2024 10:18:40 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rcRtG-0005iK-A9 for qemu-devel@nongnu.org; Tue, 20 Feb 2024 10:18:39 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1708442317; h=from:from:reply-to: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: in-reply-to:in-reply-to:references:references; bh=C1jsf7IwNL6WwGRNPRAOaUINeJ3gbCUIX2Scj9PwnDk=; b=ativiUKLTOK3lfL8viOCllE4A6gOQLH+ebJKD1I/8r9BYPqPJvQAeqMmV7+jX/gKLV1eLh Atz6ZRhL5DMLbkcyjDger8kHQxipoWOEzSxordfgmk43SKDDTEDZHOg+s62ob77TCGFyee RV+hfQwwH+wrIhqcb4U/vN2UseVKNAs= Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-622-ykCjXzbnM5y_-IJYjknT3g-1; Tue, 20 Feb 2024 10:18:35 -0500 X-MC-Unique: ykCjXzbnM5y_-IJYjknT3g-1 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.rdu2.redhat.com [10.11.54.6]) (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 mimecast-mx02.redhat.com (Postfix) with ESMTPS id 4DAE4185A783; Tue, 20 Feb 2024 15:18:35 +0000 (UTC) Received: from redhat.com (unknown [10.42.28.50]) by smtp.corp.redhat.com (Postfix) with ESMTPS id B3C302166AEE; Tue, 20 Feb 2024 15:18:33 +0000 (UTC) Date: Tue, 20 Feb 2024 15:18:31 +0000 From: Daniel =?utf-8?B?UC4gQmVycmFuZ8Op?= To: Markus Armbruster Cc: qemu-devel@nongnu.org, michael.roth@amd.com, jsnow@redhat.com, eblake@redhat.com, peter.maydell@linaro.org Subject: Re: [PATCH 09/16] qapi: Reject section heading in the middle of a doc comment Message-ID: References: <20240216145841.2099240-1-armbru@redhat.com> <20240216145841.2099240-10-armbru@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: <20240216145841.2099240-10-armbru@redhat.com> User-Agent: Mutt/2.2.12 (2023-09-09) X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.6 Received-SPF: pass client-ip=170.10.133.124; envelope-from=berrange@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -21 X-Spam_score: -2.2 X-Spam_bar: -- X-Spam_report: (-2.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.05, 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_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 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: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Daniel =?utf-8?B?UC4gQmVycmFuZ8Op?= Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org On Fri, Feb 16, 2024 at 03:58:33PM +0100, Markus Armbruster wrote: > docs/devel/qapi-code-gen.txt claims "A heading line must be the first > line of the documentation comment block" since commit > 55ec69f8b16 (docs/devel/qapi-code-gen.txt: Update to new rST backend > conventions). Not true, we have code to make it work anywhere in a > free-form doc comment: commit dcdc07a97cb (qapi: Make section headings > start a new doc comment block). > > Make it true, for simplicity's sake. > > Signed-off-by: Markus Armbruster > --- > scripts/qapi/parser.py | 6 +++--- > tests/qapi-schema/doc-good.json | 4 +++- > tests/qapi-schema/doc-non-first-section.err | 1 + > tests/qapi-schema/doc-non-first-section.json | 6 ++++++ > tests/qapi-schema/doc-non-first-section.out | 0 > 5 files changed, 13 insertions(+), 4 deletions(-) > create mode 100644 tests/qapi-schema/doc-non-first-section.err > create mode 100644 tests/qapi-schema/doc-non-first-section.json > create mode 100644 tests/qapi-schema/doc-non-first-section.out Reviewed-by: Daniel P. Berrangé With regards, Daniel -- |: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|