Re: [PATCH v5 10/20] docs/interop: Convert qemu-ga-ref to rST

[Peter Maydell <peter.maydell@linaro.org>]

On Tue, 22 Sep 2020 at 15:13, Markus Armbruster <armbru@redhat.com> wrote:
>
> Peter Maydell <peter.maydell@linaro.org> writes:
>
> > On Tue, 22 Sep 2020 at 13:01, Markus Armbruster <armbru@redhat.com> wrote:
> >> If you'd prefer to (re-)add it later, stick in TODO comment.
> >
> > Where would you want a TODO to be ?
>
> Before the patch, the licensing information is in
> docs/interop/qemu-ga-ref.texi.  That file gets replaced by
> docs/interop/qemu-ga-ref.rst, losing the licensing information.  What
> about putting the TODO right there?

I can if you insist, but what makes that .rst file any
different from all the other .rst files we have in docs/
which go into our various manuals and don't have explicit
licensing comments or reader-visible text?

If we want to improve how we inform readers of the docs
license, we might:
 * add a license note to the existing copyright footer line
 * or to have every page to have a larger copyright/license
   text section at the bottom
 * or to have the interop and other manuals have a license.rst
   like the system manual does currently,
and none of those changes would require editing qemu-ga-ref.rst
or qemu-qmp-ref.rst, because the overall problem being addressed
isn't specific to those parts of the documentation, it's a
wider one that you'd fix in a different place.

thanks
-- PMM