Re: [PATCH] qapi/control: Turn the reference to qmp-spec.rst into a link

[Markus Armbruster <armbru@redhat.com>]

John Snow <jsnow@redhat.com> writes:

> On Mon, Sep 28, 2026 at 2:32 AM Markus Armbruster <armbru@redhat.com> wrote:
>>
>> Signed-off-by: Markus Armbruster <armbru@redhat.com>
>> ---
>>  qapi/control.json | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/qapi/control.json b/qapi/control.json
>> index 9898552814..c56aabacff 100644
>> --- a/qapi/control.json
>> +++ b/qapi/control.json
>> @@ -46,7 +46,7 @@
>>  # connection, used for agreeing on particular QMP extension behaviors.
>>  #
>>  # @oob: QMP ability to support out-of-band requests.  (Please refer to
>> -#     qmp-spec.rst for more information on OOB)
>> +#     :doc:`/interop/qmp-spec` for more information on OOB)
>>  #
>>  # Since: 2.12
>>  ##
>> --
>> 2.55.0
>>
>
> I have a similar patch coming up in my rework of the @oob feature that:
>
> (1) Adds an anchor to the OOB section of the qmp spec explicitly,
> (2) Uses a standard form text with the above reference when generating
> docs for commands with the @oob property.
>
> The second doesn't apply to this command as it's an arg and not a
> feature/property; but we can do better and link directly to the OOB
> section of the spec doc.

I'm glad I cc'ed you.  Would you like me to drop this patch?  Or should
I merge it, and you improve on top?