| Message ID | 20240120095327.666239-5-armbru@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | qapi qmp: Documentation fixes | expand |
On Sat, Jan 20, 2024 at 4:53 AM Markus Armbruster <armbru@redhat.com> wrote: > > docs/interop/bitmaps.rst uses references like > > `qemu-qmp-ref <qemu-qmp-ref.html>`_ > `query-block <qemu-qmp-ref.html#index-query_002dblock>`_ > > to refer to and into docs/interop/qemu-qmp-ref.rst. > > Clean up the former: use :doc:`qemu-qmp-ref`. > > I don't know how to clean up the latter. It used to have anchors that seemed to have semi-stable names, but I guess that's not really true anymore. Now it's just stuff like `qapidoc-423`. Well, neat... No, I think this requires the Real Fix :tm: now... > > Signed-off-by: Markus Armbruster <armbru@redhat.com> > --- > docs/interop/bitmaps.rst | 4 ++-- > qapi/introspect.json | 4 ++-- > 2 files changed, 4 insertions(+), 4 deletions(-) > > diff --git a/docs/interop/bitmaps.rst b/docs/interop/bitmaps.rst > index c731be2f01..ddf8947d54 100644 > --- a/docs/interop/bitmaps.rst > +++ b/docs/interop/bitmaps.rst > @@ -167,8 +167,8 @@ Basic QMP Usage > > The primary interface to manipulating bitmap objects is via the QMP > interface. If you are not familiar, see the :doc:`qmp-spec` for the > -protocol, and `qemu-qmp-ref <qemu-qmp-ref.html>`_ for a full > -reference of all QMP commands. > +protocol, and :doc:`qemu-qmp-ref` for a full reference of all QMP > +commands. > > Supported Commands > ~~~~~~~~~~~~~~~~~~ > diff --git a/qapi/introspect.json b/qapi/introspect.json > index ebc4e199d2..8df1ce85ed 100644 > --- a/qapi/introspect.json > +++ b/qapi/introspect.json > @@ -260,8 +260,8 @@ > # Additional SchemaInfo members for meta-type 'alternate'. > # > # @members: the alternate type's members, in no particular order. The > -# members' wire encoding is distinct, see :doc:`qapi-code-gen` > -# section Alternate types. > +# members' wire encoding is distinct, see > +# :doc:`/devel/qapi-code-gen` section Alternate types. > # > # On the wire, this can be any of the members. > # > -- > 2.43.0 >
On Thu, Feb 1, 2024 at 4:45 PM John Snow <jsnow@redhat.com> wrote: > > On Sat, Jan 20, 2024 at 4:53 AM Markus Armbruster <armbru@redhat.com> wrote: > > > > docs/interop/bitmaps.rst uses references like > > > > `qemu-qmp-ref <qemu-qmp-ref.html>`_ > > `query-block <qemu-qmp-ref.html#index-query_002dblock>`_ > > > > to refer to and into docs/interop/qemu-qmp-ref.rst. > > > > Clean up the former: use :doc:`qemu-qmp-ref`. > > > > I don't know how to clean up the latter. > > It used to have anchors that seemed to have semi-stable names, but I > guess that's not really true anymore. > > Now it's just stuff like `qapidoc-423`. Well, neat... > > No, I think this requires the Real Fix :tm: now... > > > > > Signed-off-by: Markus Armbruster <armbru@redhat.com> > > --- > > docs/interop/bitmaps.rst | 4 ++-- > > qapi/introspect.json | 4 ++-- > > 2 files changed, 4 insertions(+), 4 deletions(-) > > > > diff --git a/docs/interop/bitmaps.rst b/docs/interop/bitmaps.rst > > index c731be2f01..ddf8947d54 100644 > > --- a/docs/interop/bitmaps.rst > > +++ b/docs/interop/bitmaps.rst > > @@ -167,8 +167,8 @@ Basic QMP Usage > > > > The primary interface to manipulating bitmap objects is via the QMP > > interface. If you are not familiar, see the :doc:`qmp-spec` for the > > -protocol, and `qemu-qmp-ref <qemu-qmp-ref.html>`_ for a full > > -reference of all QMP commands. > > +protocol, and :doc:`qemu-qmp-ref` for a full reference of all QMP > > +commands. > > > > Supported Commands > > ~~~~~~~~~~~~~~~~~~ > > diff --git a/qapi/introspect.json b/qapi/introspect.json > > index ebc4e199d2..8df1ce85ed 100644 > > --- a/qapi/introspect.json > > +++ b/qapi/introspect.json > > @@ -260,8 +260,8 @@ > > # Additional SchemaInfo members for meta-type 'alternate'. > > # > > # @members: the alternate type's members, in no particular order. The > > -# members' wire encoding is distinct, see :doc:`qapi-code-gen` > > -# section Alternate types. > > +# members' wire encoding is distinct, see > > +# :doc:`/devel/qapi-code-gen` section Alternate types. > > # > > # On the wire, this can be any of the members. > > # > > -- > > 2.43.0 > > fyi/to whom it may concern: "what cross-reference points are defined in our documentation?" > wget https://www.qemu.org/docs/master/objects.inv > python -m sphinx.ext.intersphinx objects.inv | less nose around to your heart's content. --js
diff --git a/docs/interop/bitmaps.rst b/docs/interop/bitmaps.rst index c731be2f01..ddf8947d54 100644 --- a/docs/interop/bitmaps.rst +++ b/docs/interop/bitmaps.rst @@ -167,8 +167,8 @@ Basic QMP Usage The primary interface to manipulating bitmap objects is via the QMP interface. If you are not familiar, see the :doc:`qmp-spec` for the -protocol, and `qemu-qmp-ref <qemu-qmp-ref.html>`_ for a full -reference of all QMP commands. +protocol, and :doc:`qemu-qmp-ref` for a full reference of all QMP +commands. Supported Commands ~~~~~~~~~~~~~~~~~~ diff --git a/qapi/introspect.json b/qapi/introspect.json index ebc4e199d2..8df1ce85ed 100644 --- a/qapi/introspect.json +++ b/qapi/introspect.json @@ -260,8 +260,8 @@ # Additional SchemaInfo members for meta-type 'alternate'. # # @members: the alternate type's members, in no particular order. The -# members' wire encoding is distinct, see :doc:`qapi-code-gen` -# section Alternate types. +# members' wire encoding is distinct, see +# :doc:`/devel/qapi-code-gen` section Alternate types. # # On the wire, this can be any of the members. #
docs/interop/bitmaps.rst uses references like `qemu-qmp-ref <qemu-qmp-ref.html>`_ `query-block <qemu-qmp-ref.html#index-query_002dblock>`_ to refer to and into docs/interop/qemu-qmp-ref.rst. Clean up the former: use :doc:`qemu-qmp-ref`. I don't know how to clean up the latter. Signed-off-by: Markus Armbruster <armbru@redhat.com> --- docs/interop/bitmaps.rst | 4 ++-- qapi/introspect.json | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-)