From nobody Tue Nov 26 20:02:02 2024 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=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1705744487; cv=none; d=zohomail.com; s=zohoarc; b=EsZ/nQDiU7pjo1YSY15+88JoqfQaM9KODISIpDMFpRdVBdN/XelfYNcJfHw4bezuv57Y9H+5CiMQ5E47uzzE+dH6i8KgPfMtlA6JM6FCtrxBLFhgOkkZqhuEeQC2gOmQX/usJGhVPdaAnKRcqPof27PB+OKheaBmDqQoyGb8ZlM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1705744487; h=Content-Type: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=8zMUZLz6aZ4QhMcvIy31bzbpBMATn24NCuvAj97hayc=; b=NTTbWOXp76hNshJ39UVZjlAomXq+pbuB8a9u2w0SF9BB+W3w2JzZ2ax8i0KzWW2hIsuq+7NRZkwUbLYx8+qNfKxorI1euLJC0XrRsTjtZqj08O7Qd+c728Lft6fnxsK0Uv7KNpP5T14SeT75UgFr+TCSB+LLw2iUegrrPyU6s4w= 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=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1705744487699599.9542335807388; Sat, 20 Jan 2024 01:54:47 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rR82l-00082s-L7; Sat, 20 Jan 2024 04:53:39 -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 1rR82j-00081B-JK for qemu-devel@nongnu.org; Sat, 20 Jan 2024 04:53:37 -0500 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 1rR82g-00062n-DQ for qemu-devel@nongnu.org; Sat, 20 Jan 2024 04:53:37 -0500 Received: from mimecast-mx02.redhat.com (mx-ext.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-307-f5XGsUK5OsG-EpFvFBYEVQ-1; Sat, 20 Jan 2024 04:53:30 -0500 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.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 mimecast-mx02.redhat.com (Postfix) with ESMTPS id D482838143A3; Sat, 20 Jan 2024 09:53:29 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.246]) by smtp.corp.redhat.com (Postfix) with ESMTPS id B3C7C2026D66; Sat, 20 Jan 2024 09:53:29 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 5E2FE21E6691; Sat, 20 Jan 2024 10:53:27 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1705744412; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=8zMUZLz6aZ4QhMcvIy31bzbpBMATn24NCuvAj97hayc=; b=JLNbwhVHNNGoz87aYCKQaYJEuPzZswBEpBok6DGQFlbS7Uv+V7+VWLTAWtxTWgRimMzh7W oLTOsvqJ5EmxAzeYPyKRldKR/6RcyJpYwzPgxOnw5KUM6KrfSofhJKVmx3UWsUY7LZPZds dfXLsZRcy4HICFXsgNML0xS9zUecRGI= X-MC-Unique: f5XGsUK5OsG-EpFvFBYEVQ-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: michael.roth@amd.com, peter.maydell@linaro.org, jsnow@redhat.com Subject: [PATCH 5/7] qapi: Fix mangled "Returns" sections in documentation Date: Sat, 20 Jan 2024 10:53:25 +0100 Message-ID: <20240120095327.666239-6-armbru@redhat.com> In-Reply-To: <20240120095327.666239-1-armbru@redhat.com> References: <20240120095327.666239-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.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=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -45 X-Spam_score: -4.6 X-Spam_bar: ---- X-Spam_report: (-4.6 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-2.519, 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: , 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: 1705744489765100003 Content-Type: text/plain; charset="utf-8" Commit e050e426782e (qapi: Use explicit bulleted lists) added list markup to correct bad rendering: A JSON block comment like this: Returns: nothing on success If @node is not a valid block device, DeviceNotFound If @name is not found, GenericError with an explanation renders like this: Returns: nothing on success If node is not a valid block device, DeviceNotFound If name is not found, GenericError with an explanat= ion because whitespace is not significant. Use an actual bulleted list, so that the formatting is correct. It missed a few instances. Commit a937b6aa739 (qapi: Reformat doc comments to conform to current conventions) then reflowed them. Revert the reflowing, and add list markup. Signed-off-by: Markus Armbruster --- qapi/net.json | 15 +++++++++------ qapi/qdev.json | 5 +++-- qapi/qom.json | 10 ++++++---- 3 files changed, 18 insertions(+), 12 deletions(-) diff --git a/qapi/net.json b/qapi/net.json index 8095b68fa8..68493d6ac9 100644 --- a/qapi/net.json +++ b/qapi/net.json @@ -18,8 +18,9 @@ # # @up: true to set the link status to be up # -# Returns: Nothing on success If @name is not a valid network device, -# DeviceNotFound +# Returns: +# - Nothing on success +# - If @name is not a valid network device, DeviceNotFound # # Since: 0.14 # @@ -44,8 +45,9 @@ # # Since: 0.14 # -# Returns: Nothing on success If @type is not a valid network backend, -# DeviceNotFound +# Returns: +# - Nothing on success +# - If @type is not a valid network backend, DeviceNotFound # # Example: # @@ -64,8 +66,9 @@ # # @id: the name of the network backend to remove # -# Returns: Nothing on success If @id is not a valid network backend, -# DeviceNotFound +# Returns: +# - Nothing on success +# - If @id is not a valid network backend, DeviceNotFound # # Since: 0.14 # diff --git a/qapi/qdev.json b/qapi/qdev.json index 6bc5a733b8..25bac5e611 100644 --- a/qapi/qdev.json +++ b/qapi/qdev.json @@ -89,8 +89,9 @@ # # @id: the device's ID or QOM path # -# Returns: Nothing on success If @id is not a valid device, -# DeviceNotFound +# Returns: +# - Nothing on success +# - If @id is not a valid device, DeviceNotFound # # Notes: When this command completes, the device may not be removed # from the guest. Hot removal is an operation that requires guest diff --git a/qapi/qom.json b/qapi/qom.json index 95516ba325..84af23fe24 100644 --- a/qapi/qom.json +++ b/qapi/qom.json @@ -1056,8 +1056,9 @@ # # Create a QOM object. # -# Returns: Nothing on success Error if @qom-type is not a valid class -# name +# Returns: +# - Nothing on success +# - Error if @qom-type is not a valid class name # # Since: 2.0 # @@ -1078,8 +1079,9 @@ # # @id: the name of the QOM object to remove # -# Returns: Nothing on success Error if @id is not a valid id for a QOM -# object +# Returns: +# - Nothing on success +# - Error if @id is not a valid id for a QOM object # # Since: 2.0 # --=20 2.43.0