docs license footer followon cleanups
cover docs license footer followon cleanups
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(-)
Signature · 1 line
2.20.1
PATCH 1/2 docs: Remove stale TODO comments about license and version
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.
--- 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(-)
docs/interop/qemu-ga-ref.rst +0 -9
@@ -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
docs/interop/qemu-qmp-ref.rst +0 -9
@@ -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
docs/interop/qemu-storage-daemon-qmp-ref.rst +0 -9
@@ -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
Signature · 1 line
2.20.1
Re: [PATCH for-6.1 1/2] docs: Remove stale TODO comments about license and version
Quoted 5 lines · Peter Maydell
Since commits
13f934e79faand3a50c8f3067aaf, 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.
Quoted 7 lines
Signed-off-by Peter Maydell <[email protected]>--- 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(-)
Re: [PATCH for-6.1 1/2] docs: Remove stale TODO comments about license and version
In reply to Peter MaydellQuoted 6 lines · Peter Maydell
Since commits
13f934e79faand3a50c8f3067aaf, 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 <[email protected]>
PATCH 2/2 docs: Move licence/copyright from HTML output to rST comments
In reply to Peter MaydellOur 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.
--- 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(-)
docs/interop/vhost-user-gpu.rst +4 -3
@@ -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
docs/interop/vhost-user.rst +7 -5
@@ -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
docs/system/generic-loader.rst +2 -2
@@ -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 --------------
Signature · 1 line
2.20.1
Re: [PATCH for-6.1 2/2] docs: Move licence/copyright from HTML output to rST comments
Quoted 12 lines · 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.
Quoted 7 lines
Suggested-by Markus Armbruster <[email protected]>Signed-off-by Peter Maydell <[email protected]>--- 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(-)
Re: [PATCH for-6.1 2/2] docs: Move licence/copyright from HTML output to rST comments
In reply to Peter MaydellQuoted 7 lines · 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.
Quoted 7 lines
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 <[email protected]>Signed-off-by Peter Maydell <[email protected]>
Quoted 64 lines
--- 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(-)docs/interop/vhost-user-gpu.rst +4
-3@@ -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 Contentsdocs/interop/vhost-user.rst +7
-5@@ -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 Contentsdocs/system/generic-loader.rst +2
-2@@ -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 --------------Signature · 1 line
2.20.1
Re: [PATCH for-6.1 2/2] docs: Move licence/copyright from HTML output to rST comments
In reply to Peter MaydellQuoted 7 lines · 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.
Quoted 7 lines
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 <[email protected]>Signed-off-by Peter Maydell <[email protected]>
Quoted 11 lines · Peter Maydell
This patchset makes a couple of followon cleanups now that commits
13f934e79faand3a50c8f3067aafare 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
Quoted 7 lines
thanks
-- PMMPeter Maydell (2):
docs: Remove stale TODO comments about license and version
docs: Move licence/copyright from HTML output to rST comments
Quoted 13 lines
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
Signature · 1 line
Marc-André Lureau