From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from list by lists.gnu.org with archive (Exim 4.90_1) id 1tx03S-0003qr-BT for mharc-qemu-trivial@gnu.org; Tue, 25 Mar 2025 04:54:38 -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 1tx03Q-0003q9-9O for qemu-trivial@nongnu.org; Tue, 25 Mar 2025 04:54:36 -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 1tx03L-0001tX-SF for qemu-trivial@nongnu.org; Tue, 25 Mar 2025 04:54:35 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1742892870; 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=3taJ8nSaknITTapWUdxXY/2sm0NWHMLOYhzkewh8Nxw=; b=NPhO28i123dkMqmTfW+53KxbEQRqMJThNF2LTgG5oJORIyjirV1Ob7eSeEKYCHtWS12sot ouncNbyqdAlq4AJvr2BeqIbH7365VUl/wplT0reUehx4DpaQI2iVqCQzeS6VMg3rkb5SzM bbCIV+aCg9GYCUXEfUc6z+vrI4XBXn4= Received: from mx-prod-mc-04.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-449-1a15-gmKOjGexRIxl_bK-A-1; Tue, 25 Mar 2025 04:54:12 -0400 X-MC-Unique: 1a15-gmKOjGexRIxl_bK-A-1 X-Mimecast-MFC-AGG-ID: 1a15-gmKOjGexRIxl_bK-A_1742892850 Received: from mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.93]) (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-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 2D5C518DB8D1; Tue, 25 Mar 2025 08:54:07 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.22.74.4]) by mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 4DAD7180B48C; Tue, 25 Mar 2025 08:54:04 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 3268A21E66C5; Tue, 25 Mar 2025 09:54:01 +0100 (CET) From: Markus Armbruster To: John Snow Cc: qemu-devel@nongnu.org, =?utf-8?Q?Marc-Andr=C3=A9?= Lureau , Hanna Reitz , Peter Xu , "Gonglei (Arei)" , Philippe =?utf-8?Q?Mathieu-Daud=C3=A9?= , Paolo Bonzini , Daniel P. =?utf-8?Q?Berrang=C3=A9?= , Ani Sinha , Michael Tokarev , Lukas Straub , Fabiano Rosas , Eduardo Habkost , Stefan Berger , qemu-trivial@nongnu.org, Jason Wang , Marcel Apfelbaum , Vladimir Sementsov-Ogievskiy , Peter Maydell , Laurent Vivier , Yanan Wang , Zhao Liu , Stefan Hajnoczi , Kevin Wolf , "Michael S. Tsirkin" , qemu-block@nongnu.org, Zhenwei Pi , Mads Ynddal , Gerd Hoffmann , Michael Roth , Eric Blake , Jiri Pirko Subject: Re: [PATCH 2/4] docs, qapi: generate undocumented return sections In-Reply-To: <20250322010857.309490-3-jsnow@redhat.com> (John Snow's message of "Fri, 21 Mar 2025 21:08:55 -0400") References: <20250322010857.309490-1-jsnow@redhat.com> <20250322010857.309490-3-jsnow@redhat.com> Date: Tue, 25 Mar 2025 09:54:01 +0100 Message-ID: <87a599o5hy.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.93 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: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 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_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-trivial@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 25 Mar 2025 08:54:36 -0000 John Snow writes: > This patch changes the qapidoc transmogrifier to generate Return value > documentation for any command that has a return value but hasn't > explicitly documented that return value. > > Signed-off-by: John Snow A number of commands lack return value documentation before the patch. These are: QGA: guest-network-get-route QMP: x-debug-query-block-graph, query-tpm, query-dirty-rate, query-vcpu-dirty-limit, query-vm-generation-id, query-memory-size-summary, query-memory-devices, query-acpi-ospm-status, query-stats-schemas, query-stats-schemas This patch fixes that. However, in my testing, it adds the missing "Return:" doc *twice* for x-debug-query-block-graph and query-dirty-rate.