Re: [PATCH v3 1/3] docs: generate qemu-storage-daemon-qmp-ref(7) man page

[Peter Maydell]

On Wed, 16 Dec 2020 at 16:21, Stefan Hajnoczi <stefanha@redhat.com> wrote:
>
> On Tue, Dec 15, 2020 at 05:11:06PM +0100, Kevin Wolf wrote:
> > > diff --git a/docs/interop/qemu-storage-daemon-qmp-ref.rst 
> > > b/docs/interop/qemu-storage-daemon-qmp-ref.rst
> > > new file mode 100644
> > > index 0000000000..caf9dad23a
> > > --- /dev/null
> > > +++ b/docs/interop/qemu-storage-daemon-qmp-ref.rst
> > > @@ -0,0 +1,13 @@
> > > +QEMU Storage Daemon QMP Reference Manual
> > > +========================================
> > > +
> > > +..
> > > +   TODO: the old Texinfo manual used to note that this manual
> > > +   is GPL-v2-or-later. We should make that reader-visible
> > > +   both here and in our Sphinx manuals more generally.
> > > +
> > > +..
> > > +   TODO: display the QEMU version, both here and in our Sphinx manuals
> > > +   more generally.
> > > +
> > > +.. qapi-doc:: storage-daemon/qapi/qapi-schema.json
> >
> > Did you intend to actually merge the TODO comments like this into master
> > or was this meant to be resolved before you send the series?
>
> Thanks for pointing this out. Both qemu-qmp-ref.rst and qemu-ga-ref.rst
> have these comments and I copied them when creating the file. I don't
> intend to try to solve that in this series.
>
> Would you like to keep the comments or should I drop them?

FWIW, the ones in those two docs are the result of a request
from Markus when we were doing the conversion of QAPI generated
docs from Texinfo to rST -- the old separate Texinfo-generated
docs ended up with a version/license statement in the generated
docs. Fixing this depends I think on the "merge the 5 manuals
into one single manual" patch; once that's done then it should
be easier to have one consistent place to note license, copyright,
version, etc.

thanks
-- PMM