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 0735CC83F17 for ; Mon, 28 Jul 2025 12:52:57 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ugNLH-0008M4-5j; Mon, 28 Jul 2025 08:52:35 -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 1ugMhA-0002qP-QW for qemu-devel@nongnu.org; Mon, 28 Jul 2025 08:11:09 -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 1ugMh6-0007YN-Nv for qemu-devel@nongnu.org; Mon, 28 Jul 2025 08:11:08 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1753704659; 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=kbYxL/ly2XklUhNArkxf6qi9ZkqCOj1gCPf/PVdaZ0w=; b=bneUAtjV8IlSH7gJfJ/0CST6XiOGumcHOaW0+wEhAQ1tzOrUDzTq6v96BJ4vJmkfucYpZ7 s6nr/WClRriBnryaYnCNoEtig8gouuDb4IE7KkZ/cdOYPzv1tg7S4SvHMp9yksCxWyKaxq woJqCcuIxGk0p2wHjoEJb7H+0WsgUKY= Received: from mx-prod-mc-06.mail-002.prod.us-west-2.aws.redhat.com (ec2-35-165-154-97.us-west-2.compute.amazonaws.com [35.165.154.97]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-645-q2Mk4nq2PaiYht8ewpCc3w-1; Mon, 28 Jul 2025 08:10:58 -0400 X-MC-Unique: q2Mk4nq2PaiYht8ewpCc3w-1 X-Mimecast-MFC-AGG-ID: q2Mk4nq2PaiYht8ewpCc3w_1753704657 Received: from mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.111]) (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-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 5675D1800772 for ; Mon, 28 Jul 2025 12:10:57 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.45.242.14]) by mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id B6BB91800B6C for ; Mon, 28 Jul 2025 12:10:56 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 0D3DF21E6A27; Mon, 28 Jul 2025 14:10:54 +0200 (CEST) From: Markus Armbruster To: John Snow Cc: qemu-devel@nongnu.org, eblake@redhat.com Subject: Re: [PATCH] qapi: Add more cross-references In-Reply-To: (John Snow's message of "Mon, 21 Jul 2025 16:22:52 -0400") References: <20250717115751.3832597-1-armbru@redhat.com> Date: Mon, 28 Jul 2025 14:10:54 +0200 Message-ID: <87v7nco6r5.fsf@pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.111 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_PASS=-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.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: > On Thu, Jul 17, 2025 at 7:57=E2=80=AFAM Markus Armbruster wrote: >> >> We recently (merge commit 504632dcc631) enclosed command and type >> names in `backquotes`, so they become links in generated HTML. Take >> care of a few we missed. >> >> Signed-off-by: Markus Armbruster >> --- >> qapi/dump.json | 2 +- >> qapi/machine.json | 2 +- >> qapi/migration.json | 4 ++-- >> qapi/misc-i386.json | 2 +- >> qapi/run-state.json | 2 +- >> qapi/sockets.json | 2 +- >> 6 files changed, 7 insertions(+), 7 deletions(-) >> >> diff --git a/qapi/dump.json b/qapi/dump.json >> index 32c8c1f06e..726b520870 100644 >> --- a/qapi/dump.json >> +++ b/qapi/dump.json >> @@ -79,7 +79,7 @@ >> # >> # @detach: if true, QMP will return immediately rather than waiting >> # for the dump to finish. The user can track progress using >> -# "query-dump". (since 2.6). >> +# `query-dump`. (since 2.6). > > Funny. Offset and in quotes, so it got missed. I believe your script's heuristic for skipping example blocks skipped too many intented lines. It dealt fine with quotes as far as I can tell. >> # >> # @begin: if specified, the starting physical address. >> # >> diff --git a/qapi/machine.json b/qapi/machine.json >> index 6f59f70ca6..038eab281c 100644 >> --- a/qapi/machine.json >> +++ b/qapi/machine.json >> @@ -2087,7 +2087,7 @@ >> # >> # @deprecated-props: an optional list of properties that are flagged as >> # deprecated by the CPU vendor. The list depends on the >> -# CpuModelExpansionType: "static" properties are a subset of the >> +# `CpuModelExpansionType`: "static" properties are a subset of the > > "What are the odds that a name we want to turn into a reference will > be immediately followed by a colon?" 100%, I guess. > >> # enabled-properties for the expanded model; "full" properties are >> # a set of properties that are deprecated across all models for >> # the architecture. (since: 10.1 -- since 9.1 on s390x --). >> diff --git a/qapi/migration.json b/qapi/migration.json >> index e08a99bb82..2387c21e9c 100644 >> --- a/qapi/migration.json >> +++ b/qapi/migration.json >> @@ -641,7 +641,7 @@ >> # >> # This mode supports VFIO devices provided the user first puts the >> # guest in the suspended runstate, such as by issuing >> -# guest-suspend-ram to the QEMU guest agent. >> +# `guest-suspend-ram` to the QEMU guest agent. > > Missed because it's indented? Think so. >> # >> # Best performance is achieved when the memory backend is shared >> # and the @x-ignore-shared migration capability is set, but this >> @@ -1704,7 +1704,7 @@ >> # >> # .. admonition:: Notes >> # >> -# 1. The 'query-migrate' command should be used to check >> +# 1. The `query-migrate` command should be used to check >> # migration's progress and final result (this information is >> # provided by the 'status' member). > > Indent miss. > >> # >> diff --git a/qapi/misc-i386.json b/qapi/misc-i386.json >> index c8c91a241c..d1ce8caf25 100644 >> --- a/qapi/misc-i386.json >> +++ b/qapi/misc-i386.json >> @@ -8,7 +8,7 @@ >> # >> # Reset the RTC interrupt reinjection backlog. Can be used if another >> # mechanism to synchronize guest time is in effect, for example QEMU >> -# guest agent's guest-set-time command. >> +# guest agent's `guest-set-time` command. > > Why'd I miss this one, I wonder? You searched for identifies defined in qapi/. This one's from qga/. >> # >> # Use of this command is only applicable for x86 machines with an RTC, >> # and on other machines will silently return without performing any >> diff --git a/qapi/run-state.json b/qapi/run-state.json >> index 54ba5c9a3f..4757947ca6 100644 >> --- a/qapi/run-state.json >> +++ b/qapi/run-state.json >> @@ -20,7 +20,7 @@ >> # @inmigrate: guest is paused waiting for an incoming migration. Note >> # that this state does not tell whether the machine will start at >> # the end of the migration. This depends on the command-line -S >> -# option and any invocation of 'stop' or 'cont' that has happened >> +# option and any invocation of `stop` or `cont` that has happened > > Rare instance of actually *wanting* these to be cross-refs. :) Yes. >> # since QEMU was started. >> # >> # @internal-error: An internal error that prevents further guest >> diff --git a/qapi/sockets.json b/qapi/sockets.json >> index 82046b0b3a..32fac51728 100644 >> --- a/qapi/sockets.json >> +++ b/qapi/sockets.json >> @@ -143,7 +143,7 @@ >> # >> # @str: decimal is for file descriptor number, otherwise it's a file >> # descriptor name. Named file descriptors are permitted in >> -# monitor commands, in combination with the 'getfd' command. >> +# monitor commands, in combination with the `getfd` command. >> # Decimal file descriptors are permitted at startup or other >> # contexts where no monitor context is active. > > Presumably another indent miss. > >> # >> -- >> 2.49.0 > > Reviewed-by: John Snow Thanks!