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 919C4C2BD09 for ; Tue, 9 Jul 2024 11:31:44 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sR93E-0004Ip-DN; Tue, 09 Jul 2024 07:30:28 -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 1sR93C-0004Df-NI for qemu-devel@nongnu.org; Tue, 09 Jul 2024 07:30:26 -0400 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 1sR93A-0001oh-8L for qemu-devel@nongnu.org; Tue, 09 Jul 2024 07:30:26 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1720524622; 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=vetLnNqVPvYWDfUw4fnuuVJLQxZ/cUwh3xHUG9ixUwo=; b=b+xvJ2HTVV2qMAElaawA8b9BqDFcM9NKmdn7L/4GQNlNCjizb3v6ARal4MCFasGJIbQB/B U+voBYVzFDwrMegNk/aLfrgi/By3dTqlBENninoX4/uF5+qc2QbzTREoxe2lIMJUMT6YVD OepeuGKIUsMLTQK+p2eYleswEjFDUmE= Received: from mx-prod-mc-01.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-74-CcYxIOpBPIqJIPnynYYMFQ-1; Tue, 09 Jul 2024 07:30:17 -0400 X-MC-Unique: CcYxIOpBPIqJIPnynYYMFQ-1 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-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 4E2DA196CDF5; Tue, 9 Jul 2024 11:30:15 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.4]) by mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id CFDCB3000181; Tue, 9 Jul 2024 11:30:13 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id C294321E668B; Tue, 9 Jul 2024 13:30:11 +0200 (CEST) From: Markus Armbruster To: John Snow Cc: qemu-devel@nongnu.org, "Michael S. Tsirkin" , Peter Xu , qemu-block@nongnu.org, =?utf-8?Q?Marc-Andr=C3=A9?= Lureau , Kevin Wolf , Philippe =?utf-8?Q?Mathieu-Daud=C3=A9?= , Peter Maydell , =?utf-8?Q?C=C3=A9dric?= Le Goater , Eduardo Habkost , Daniel P. =?utf-8?Q?Berrang=C3=A9?= , Paolo Bonzini , Fabiano Rosas , Pavel Dovgalyuk , Stefan Hajnoczi , Jason Wang , Lukas Straub , Ani Sinha , Igor Mammedov , Michael Roth , Hanna Reitz , Mads Ynddal , Alex Williamson , Eric Blake , Marcel Apfelbaum , Yanan Wang , Jiri Pirko Subject: Re: [PATCH 6/8] qapi: convert "Example" sections with titles In-Reply-To: <20240703210144.339530-7-jsnow@redhat.com> (John Snow's message of "Wed, 3 Jul 2024 17:01:41 -0400") References: <20240703210144.339530-1-jsnow@redhat.com> <20240703210144.339530-7-jsnow@redhat.com> Date: Tue, 09 Jul 2024 13:30:11 +0200 Message-ID: <87ttgyg5vg.fsf@pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.4 Received-SPF: pass client-ip=170.10.133.124; envelope-from=armbru@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.144, 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 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+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org John Snow writes: > When an Example section has a brief explanation, convert it to a > qmp-example:: section using the :title: option. > > Rule of thumb: If the title can fit on a single line and requires no rST > markup, it's a good candidate for using the :title: option of > qmp-example. > > In this patch, trailing punctuation is removed from the title section > for consistent headline aesthetics. In just one case, specifics of the > example are removed to make the title read better. > > See commit-4: "docs/qapidoc: create qmp-example directive", for a > detailed explanation of this custom directive syntax. > > See commit+2: "qapi: remove "Example" doc section" for a detailed > explanation of why. > > Signed-off-by: John Snow Reviewed-by: Markus Armbruster