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

[Markus Armbruster]

Peter Maydell <peter.maydell@linaro.org> writes:

> On Fri, 4 Sep 2020 at 14:16, Markus Armbruster <armbru@redhat.com> wrote:
>>
>> Peter Maydell <peter.maydell@linaro.org> writes:
>>
>> > Convert qemu-ga-ref to rST format. This includes dropping
>> > the plain-text, pdf and info format outputs for this document;
>> > as with all our other Sphinx-based documentation, we provide
>> > HTML and manpage only.
>
>> > -@copying
>> > -This is the QEMU Guest Agent Protocol reference manual.
>> > -
>> > -Copyright @copyright{} 2016 The QEMU Project developers
>> > -
>> > -@quotation
>> > -This manual is free documentation: you can redistribute it and/or
>> > -modify it under the terms of the GNU General Public License as
>> > -published by the Free Software Foundation, either version 2 of the
>> > -License, or (at your option) any later version.
>> > -
>> > -This manual is distributed in the hope that it will be useful, but
>> > -WITHOUT ANY WARRANTY; without even the implied warranty of
>> > -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
>> > -General Public License for more details.
>> > -
>> > -You should have received a copy of the GNU General Public License
>> > -along with this manual.  If not, see http://www.gnu.org/licenses/.
>> > -@end quotation
>> > -@end copying
>>
>> Does the interop manual carry an equivalent copyright notice?
>
> NB: in the Texinfo versions, Texinfo does not put this copyright/license
> notice in its generated manpages, and it is in the generated HTML only
> as an HTML comment, not visible to the ordinary reader.

For what it's worth, the generated PDF has it on page 2.

> The Sphinx interop manual has the usual footer:
> https://www.qemu.org/docs/master/interop/index.html
> "©2020, The QEMU Project Developers."
>
> The system manual has an explicit "License" section:
> https://www.qemu.org/docs/master/system/license.html
> but that's documenting the license of the program, not the
> manual (it's docs/system/license.rst).
>
> We could do any or all of:
>  * decide that we're happy with the current situation
>  * expand the "copyright" footer to something like
>    '©2020, The QEMU Project Developers; this manual is GPLv2'
>  * have a docs/foo/license.rst for each manual, and expand
>    it to mention the documentation license as well as the
>    code license
>
> Given that the Texinfo generated QMP/QGA references don't
> actually present this text to the reader, my inclination
> is to say that this is something we should address in
> a separate patchseries, not as part of this conversion.

I think the manual should have a proper copyright notice.

If you'd prefer to (re-)add it later, stick in TODO comment.