Re: [PATCH 15/18] qapi: add cross-references to ui.json

[Markus Armbruster <armbru@redhat.com>]

John Snow <jsnow@redhat.com> writes:

> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>  qapi/ui.json | 34 +++++++++++++++++-----------------
>  1 file changed, 17 insertions(+), 17 deletions(-)
>
> diff --git a/qapi/ui.json b/qapi/ui.json
> index 7136c985c38..5bc54403cc2 100644
> --- a/qapi/ui.json
> +++ b/qapi/ui.json
> @@ -39,7 +39,7 @@
>  ##
>  # @SetPasswordOptions:
>  #
> -# Options for set_password.
> +# Options for `set_password`.
>  #
>  # @protocol:
>  #     - 'vnc' to modify the VNC server password
> @@ -63,7 +63,7 @@
>  ##
>  # @SetPasswordOptionsVnc:
>  #
> -# Options for set_password specific to the VNC protocol.
> +# Options for `set_password` specific to the VNC protocol.
>  #
>  # @display: The id of the display where the password should be
>  #     changed.  Defaults to the first.
> @@ -94,7 +94,7 @@
>  ##
>  # @ExpirePasswordOptions:
>  #
> -# General options for expire_password.
> +# General options for `expire_password`.
>  #
>  # @protocol:
>  #     - 'vnc' to modify the VNC server expiration
> @@ -124,7 +124,7 @@
>  ##
>  # @ExpirePasswordOptionsVnc:
>  #
> -# Options for expire_password specific to the VNC protocol.
> +# Options for `expire_password` specific to the VNC protocol.
>  #
>  # @display: The id of the display where the expiration should be
>  #     changed.  Defaults to the first.
> @@ -183,7 +183,7 @@
>  #     the head can only be specified in conjunction with the device
>  #     ID.  (Since 2.12)
>  #
> -# @format: image format for screendump.  (default: ppm) (Since 7.1)
> +# @format: image format for `screendump`.  (default: ppm) (Since 7.1)

This is a link from a command argument back to the command.  Meh.  The
real issue is of course that the argument description is sub-par: "for
screendump" is entirely redundant.  Not for this patch to address.

Similarly crappy text descriptions may well exist elsewhere.  If we care
to clean them up, perhaps we can use "link to definition within the same
definition" to find them.

>  #
>  # Since: 0.14
>  #

[...]