docs license footer followon cleanups

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

Posted by Peter Maydell 4 years, 6 months ago

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

Posted by Cleber Rosa 4 years, 6 months ago

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

Posted by Michael S. Tsirkin 4 years, 6 months ago

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

Posted by Markus Armbruster 4 years, 6 months ago

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>