Re: [PATCH 3/3] docs/devel/qtest: Include libqtest API reference

[Eduardo Habkost]

On Tue, Oct 06, 2020 at 07:12:17PM +0200, Thomas Huth wrote:
> On 05/10/2020 22.52, Eduardo Habkost wrote:
> > Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
> > ---
> >   docs/devel/qtest.rst          |  6 ++++++
> >   tests/qtest/libqos/libqtest.h | 20 ++++++++++----------
> >   2 files changed, 16 insertions(+), 10 deletions(-)
> > 
> > diff --git a/docs/devel/qtest.rst b/docs/devel/qtest.rst
> > index 3bf9ebee7f0..075fe5f7d53 100644
> > --- a/docs/devel/qtest.rst
> > +++ b/docs/devel/qtest.rst
> > @@ -64,3 +64,9 @@ QTest Protocol
> >   .. kernel-doc:: softmmu/qtest.c
> >      :doc: QTest Protocol
> > +
> > +
> > +libqtest API reference
> > +----------------------
> > +
> > +.. kernel-doc:: tests/qtest/libqos/libqtest.h
> > diff --git a/tests/qtest/libqos/libqtest.h b/tests/qtest/libqos/libqtest.h
> > index a6ee1654f20..209fcf69737 100644
> > --- a/tests/qtest/libqos/libqtest.h
> > +++ b/tests/qtest/libqos/libqtest.h
> > @@ -24,7 +24,7 @@ typedef struct QTestState QTestState;
> >   /**
> >    * qtest_initf:
> > - * @fmt...: Format for creating other arguments to pass to QEMU, formatted
> > + * @fmt: Format for creating other arguments to pass to QEMU, formatted
> >    * like sprintf().
> >    *
> >    * Convenience wrapper around qtest_init().
> > @@ -87,7 +87,7 @@ void qtest_quit(QTestState *s);
> >    * @s: #QTestState instance to operate on.
> >    * @fds: array of file descriptors
> >    * @fds_num: number of elements in @fds
> > - * @fmt...: QMP message to send to qemu, formatted like
> > + * @fmt: QMP message to send to qemu, formatted like
> >    * qobject_from_jsonf_nofail().  See parse_escape() for what's
> >    * supported after '%'.
> >    *
> > @@ -100,7 +100,7 @@ QDict *qtest_qmp_fds(QTestState *s, int *fds, size_t 
> > fds_num,
> >   /**
> >    * qtest_qmp:
> >    * @s: #QTestState instance to operate on.
> > - * @fmt...: QMP message to send to qemu, formatted like
> > + * @fmt: QMP message to send to qemu, formatted like
> 
> I think you should mention those changes to all those "fmt..." in the commit
> message?

Yes.  I mentioned "after converting it to Sphinx syntax" on patch
2/3, but forgot to mention the same thing in this patch.

-- 
Eduardo