[PATCH for-6.1 0/2] docs license footer followon cleanups

[PATCH for-6.1 0/2] docs license footer followon cleanups

[Peter Maydell]

This patchset makes a couple of followon cleanups now that
commits 13f934e79fa and 3a50c8f3067aaf are in master and our HTML
documentation has a footer to all pages stating the QEMU license
and version:
 * it removes the TODO comments, because we've now done them
 * three .rst files were rendering their own copyright or
   license information into the user-visible HTML, which is
   a bit confusing now that we also do this in the page footer;
   patch 2 brings those files into line with the others by having
   the comment/license only in a rST comment

thanks
-- PMM

Peter Maydell (2):
  docs: Remove stale TODO comments about license and version
  docs: Move licence/copyright from HTML output to rST comments

 docs/interop/qemu-ga-ref.rst                 |  9 ---------
 docs/interop/qemu-qmp-ref.rst                |  9 ---------
 docs/interop/qemu-storage-daemon-qmp-ref.rst |  9 ---------
 docs/interop/vhost-user-gpu.rst              |  7 ++++---
 docs/interop/vhost-user.rst                  | 12 +++++++-----
 docs/system/generic-loader.rst               |  4 ++--
 6 files changed, 13 insertions(+), 37 deletions(-)

-- 
2.20.1

[PATCH for-6.1 1/2] docs: Remove stale TODO comments about license and version

[Peter Maydell]

Since commits 13f934e79fa and 3a50c8f3067aaf, our HTML docs include a
footer to all pages stating the license and version.  We can
therefore delete the TODO comments suggesting we should do that from
our .rst files.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
 docs/interop/qemu-ga-ref.rst                 | 9 ---------
 docs/interop/qemu-qmp-ref.rst                | 9 ---------
 docs/interop/qemu-storage-daemon-qmp-ref.rst | 9 ---------
 3 files changed, 27 deletions(-)

diff --git a/docs/interop/qemu-ga-ref.rst b/docs/interop/qemu-ga-ref.rst
index db1e9461249..032d4924552 100644
--- a/docs/interop/qemu-ga-ref.rst
+++ b/docs/interop/qemu-ga-ref.rst
@@ -1,15 +1,6 @@
 QEMU Guest Agent Protocol Reference
 ===================================
 
-..
-   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.
-
 .. contents::
    :depth: 3
 
diff --git a/docs/interop/qemu-qmp-ref.rst b/docs/interop/qemu-qmp-ref.rst
index b5bebf6b9a9..357effd64f3 100644
--- a/docs/interop/qemu-qmp-ref.rst
+++ b/docs/interop/qemu-qmp-ref.rst
@@ -1,15 +1,6 @@
 QEMU 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.
-
 .. contents::
    :depth: 3
 
diff --git a/docs/interop/qemu-storage-daemon-qmp-ref.rst b/docs/interop/qemu-storage-daemon-qmp-ref.rst
index d0ebb42ebd5..9fed68152f5 100644
--- a/docs/interop/qemu-storage-daemon-qmp-ref.rst
+++ b/docs/interop/qemu-storage-daemon-qmp-ref.rst
@@ -1,15 +1,6 @@
 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.
-
 .. contents::
    :depth: 3
 
-- 
2.20.1

Re: [PATCH for-6.1 1/2] docs: Remove stale TODO comments about license and version

[Cleber Rosa]

Peter Maydell writes:

> Since commits 13f934e79fa and 3a50c8f3067aaf, our HTML docs include a
> footer to all pages stating the license and version.  We can
> therefore delete the TODO comments suggesting we should do that from
> our .rst files.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
>  docs/interop/qemu-ga-ref.rst                 | 9 ---------
>  docs/interop/qemu-qmp-ref.rst                | 9 ---------
>  docs/interop/qemu-storage-daemon-qmp-ref.rst | 9 ---------
>  3 files changed, 27 deletions(-)
>

Reviewed-by: Cleber Rosa <crosa@redhat.com>

Re: [PATCH for-6.1 1/2] docs: Remove stale TODO comments about license and version

[Markus Armbruster]

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

> Since commits 13f934e79fa and 3a50c8f3067aaf, our HTML docs include a
> footer to all pages stating the license and version.  We can
> therefore delete the TODO comments suggesting we should do that from
> our .rst files.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

Reviewed-by: Markus Armbruster <armbru@redhat.com>

[PATCH for-6.1 2/2] docs: Move licence/copyright from HTML output to rST comments

[Peter Maydell]

Our built HTML documentation now has a standard footer which
gives the license for QEMU (and its documentation as a whole).
In almost all pages, we either don't bother to state the
copyright/license for the individual rST sources, or we put
it in an rST comment. There are just three pages which render
copyright or license information into the user-visible HTML.

Quoting a specific (different) license for an individual HTML
page within the manual is confusing. Downgrade the license
and copyright info to a comment within the rST source, bringing
these pages in line with the rest of our documents.

Suggested-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
 docs/interop/vhost-user-gpu.rst |  7 ++++---
 docs/interop/vhost-user.rst     | 12 +++++++-----
 docs/system/generic-loader.rst  |  4 ++--
 3 files changed, 13 insertions(+), 10 deletions(-)

diff --git a/docs/interop/vhost-user-gpu.rst b/docs/interop/vhost-user-gpu.rst
index 3268bf405ce..71a2c52b313 100644
--- a/docs/interop/vhost-user-gpu.rst
+++ b/docs/interop/vhost-user-gpu.rst
@@ -2,9 +2,10 @@
 Vhost-user-gpu Protocol
 =======================
 
-:Licence: This work is licensed under the terms of the GNU GPL,
-          version 2 or later. See the COPYING file in the top-level
-          directory.
+..
+  Licence: This work is licensed under the terms of the GNU GPL,
+           version 2 or later. See the COPYING file in the top-level
+           directory.
 
 .. contents:: Table of Contents
 
diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst
index d6085f70452..d63f8d3f93a 100644
--- a/docs/interop/vhost-user.rst
+++ b/docs/interop/vhost-user.rst
@@ -1,11 +1,13 @@
 ===================
 Vhost-user Protocol
 ===================
-:Copyright: 2014 Virtual Open Systems Sarl.
-:Copyright: 2019 Intel Corporation
-:Licence: This work is licensed under the terms of the GNU GPL,
-          version 2 or later. See the COPYING file in the top-level
-          directory.
+
+..
+  Copyright 2014 Virtual Open Systems Sarl.
+  Copyright 2019 Intel Corporation
+  Licence: This work is licensed under the terms of the GNU GPL,
+           version 2 or later. See the COPYING file in the top-level
+           directory.
 
 .. contents:: Table of Contents
 
diff --git a/docs/system/generic-loader.rst b/docs/system/generic-loader.rst
index 531ddbc8e34..4f9fb005f1d 100644
--- a/docs/system/generic-loader.rst
+++ b/docs/system/generic-loader.rst
@@ -1,8 +1,8 @@
 ..
    Copyright (c) 2016, Xilinx Inc.
 
-This work is licensed under the terms of the GNU GPL, version 2 or later.  See
-the COPYING file in the top-level directory.
+   This work is licensed under the terms of the GNU GPL, version 2 or later.  See
+   the COPYING file in the top-level directory.
 
 Generic Loader
 --------------
-- 
2.20.1

Re: [PATCH for-6.1 2/2] docs: Move licence/copyright from HTML output to rST comments

[Cleber Rosa]

Peter Maydell writes:

> Our built HTML documentation now has a standard footer which
> gives the license for QEMU (and its documentation as a whole).
> In almost all pages, we either don't bother to state the
> copyright/license for the individual rST sources, or we put
> it in an rST comment. There are just three pages which render
> copyright or license information into the user-visible HTML.
>
> Quoting a specific (different) license for an individual HTML
> page within the manual is confusing. Downgrade the license
> and copyright info to a comment within the rST source, bringing
> these pages in line with the rest of our documents.
>
> Suggested-by: Markus Armbruster <armbru@redhat.com>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
>  docs/interop/vhost-user-gpu.rst |  7 ++++---
>  docs/interop/vhost-user.rst     | 12 +++++++-----
>  docs/system/generic-loader.rst  |  4 ++--
>  3 files changed, 13 insertions(+), 10 deletions(-)

Reviewed-by: Cleber Rosa <crosa@redhat.com>

Re: [PATCH for-6.1 2/2] docs: Move licence/copyright from HTML output to rST comments

[Michael S. Tsirkin]

On Thu, Jul 22, 2021 at 08:20:16PM +0100, Peter Maydell wrote:
> Our built HTML documentation now has a standard footer which
> gives the license for QEMU (and its documentation as a whole).
> In almost all pages, we either don't bother to state the
> copyright/license for the individual rST sources, or we put
> it in an rST comment. There are just three pages which render
> copyright or license information into the user-visible HTML.
> 
> Quoting a specific (different) license for an individual HTML
> page within the manual is confusing. Downgrade the license
> and copyright info to a comment within the rST source, bringing
> these pages in line with the rest of our documents.
> 
> Suggested-by: Markus Armbruster <armbru@redhat.com>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

Acked-by: Michael S. Tsirkin <mst@redhat.com>

> ---
>  docs/interop/vhost-user-gpu.rst |  7 ++++---
>  docs/interop/vhost-user.rst     | 12 +++++++-----
>  docs/system/generic-loader.rst  |  4 ++--
>  3 files changed, 13 insertions(+), 10 deletions(-)
> 
> diff --git a/docs/interop/vhost-user-gpu.rst b/docs/interop/vhost-user-gpu.rst
> index 3268bf405ce..71a2c52b313 100644
> --- a/docs/interop/vhost-user-gpu.rst
> +++ b/docs/interop/vhost-user-gpu.rst
> @@ -2,9 +2,10 @@
>  Vhost-user-gpu Protocol
>  =======================
>  
> -:Licence: This work is licensed under the terms of the GNU GPL,
> -          version 2 or later. See the COPYING file in the top-level
> -          directory.
> +..
> +  Licence: This work is licensed under the terms of the GNU GPL,
> +           version 2 or later. See the COPYING file in the top-level
> +           directory.
>  
>  .. contents:: Table of Contents
>  
> diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst
> index d6085f70452..d63f8d3f93a 100644
> --- a/docs/interop/vhost-user.rst
> +++ b/docs/interop/vhost-user.rst
> @@ -1,11 +1,13 @@
>  ===================
>  Vhost-user Protocol
>  ===================
> -:Copyright: 2014 Virtual Open Systems Sarl.
> -:Copyright: 2019 Intel Corporation
> -:Licence: This work is licensed under the terms of the GNU GPL,
> -          version 2 or later. See the COPYING file in the top-level
> -          directory.
> +
> +..
> +  Copyright 2014 Virtual Open Systems Sarl.
> +  Copyright 2019 Intel Corporation
> +  Licence: This work is licensed under the terms of the GNU GPL,
> +           version 2 or later. See the COPYING file in the top-level
> +           directory.
>  
>  .. contents:: Table of Contents
>  
> diff --git a/docs/system/generic-loader.rst b/docs/system/generic-loader.rst
> index 531ddbc8e34..4f9fb005f1d 100644
> --- a/docs/system/generic-loader.rst
> +++ b/docs/system/generic-loader.rst
> @@ -1,8 +1,8 @@
>  ..
>     Copyright (c) 2016, Xilinx Inc.
>  
> -This work is licensed under the terms of the GNU GPL, version 2 or later.  See
> -the COPYING file in the top-level directory.
> +   This work is licensed under the terms of the GNU GPL, version 2 or later.  See
> +   the COPYING file in the top-level directory.
>  
>  Generic Loader
>  --------------
> -- 
> 2.20.1

Re: [PATCH for-6.1 2/2] docs: Move licence/copyright from HTML output to rST comments

[Markus Armbruster]

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

> Our built HTML documentation now has a standard footer which
> gives the license for QEMU (and its documentation as a whole).
> In almost all pages, we either don't bother to state the
> copyright/license for the individual rST sources, or we put
> it in an rST comment. There are just three pages which render
> copyright or license information into the user-visible HTML.
>
> Quoting a specific (different) license for an individual HTML
> page within the manual is confusing. Downgrade the license
> and copyright info to a comment within the rST source, bringing
> these pages in line with the rest of our documents.
>
> Suggested-by: Markus Armbruster <armbru@redhat.com>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

Reviewed-by: Markus Armbruster <armbru@redhat.com>

Re: [PATCH for-6.1 0/2] docs license footer followon cleanups

[Marc-André Lureau]

[-- Attachment #1: Type: text/plain, Size: 1413 bytes --]

On Thu, Jul 22, 2021 at 11:23 PM Peter Maydell <peter.maydell@linaro.org>
wrote:

> This patchset makes a couple of followon cleanups now that
> commits 13f934e79fa and 3a50c8f3067aaf are in master and our HTML
> documentation has a footer to all pages stating the QEMU license
> and version:
>  * it removes the TODO comments, because we've now done them
>  * three .rst files were rendering their own copyright or
>    license information into the user-visible HTML, which is
>    a bit confusing now that we also do this in the page footer;
>    patch 2 brings those files into line with the others by having
>    the comment/license only in a rST comment
>
> thanks
> -- PMM
>
> Peter Maydell (2):
>   docs: Remove stale TODO comments about license and version
>   docs: Move licence/copyright from HTML output to rST comments
>

Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>


>  docs/interop/qemu-ga-ref.rst                 |  9 ---------
>  docs/interop/qemu-qmp-ref.rst                |  9 ---------
>  docs/interop/qemu-storage-daemon-qmp-ref.rst |  9 ---------
>  docs/interop/vhost-user-gpu.rst              |  7 ++++---
>  docs/interop/vhost-user.rst                  | 12 +++++++-----
>  docs/system/generic-loader.rst               |  4 ++--
>  6 files changed, 13 insertions(+), 37 deletions(-)
>
> --
> 2.20.1
>
>
>

-- 
Marc-André Lureau

[-- Attachment #2: Type: text/html, Size: 2144 bytes --]