| Message ID | 20210705095547.15790-5-peter.maydell@linaro.org |
|---|---|
| State | New |
| Headers | show |
| Series | docs: State QEMU version and license in all HTML footers | expand |
On 7/5/21 11:55 AM, Peter Maydell wrote: > Now that we have a single Sphinx manual rather than multiple manuals, > we can provide a better place for "common to all of QEMU" information > like the deprecation notices, build platforms, license information, > which we currently have in the system/ manual even though it applies > to all of QEMU. > > Create a new directory about/ on the same level as system/, user/, > etc, and move these documents there. > > Signed-off-by: Peter Maydell <peter.maydell@linaro.org> > --- > docs/{system => about}/build-platforms.rst | 0 > docs/{system => about}/deprecated.rst | 0 > docs/about/index.rst | 10 ++++++++++ > docs/{system => about}/license.rst | 0 > docs/{system => about}/removed-features.rst | 0 > docs/index.rst | 1 + > docs/system/index.rst | 4 ---- > 7 files changed, 11 insertions(+), 4 deletions(-) > rename docs/{system => about}/build-platforms.rst (100%) > rename docs/{system => about}/deprecated.rst (100%) > create mode 100644 docs/about/index.rst > rename docs/{system => about}/license.rst (100%) > rename docs/{system => about}/removed-features.rst (100%) Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
On Mon, Jul 05, 2021 at 10:55:44AM +0100, Peter Maydell wrote: > Now that we have a single Sphinx manual rather than multiple manuals, > we can provide a better place for "common to all of QEMU" information > like the deprecation notices, build platforms, license information, > which we currently have in the system/ manual even though it applies > to all of QEMU. > > Create a new directory about/ on the same level as system/, user/, > etc, and move these documents there. > > Signed-off-by: Peter Maydell <peter.maydell@linaro.org> > --- > docs/{system => about}/build-platforms.rst | 0 > docs/{system => about}/deprecated.rst | 0 > docs/about/index.rst | 10 ++++++++++ > docs/{system => about}/license.rst | 0 > docs/{system => about}/removed-features.rst | 0 > docs/index.rst | 1 + > docs/system/index.rst | 4 ---- > 7 files changed, 11 insertions(+), 4 deletions(-) > rename docs/{system => about}/build-platforms.rst (100%) > rename docs/{system => about}/deprecated.rst (100%) > create mode 100644 docs/about/index.rst > rename docs/{system => about}/license.rst (100%) > rename docs/{system => about}/removed-features.rst (100%) Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> This changes hyperlinks for the pages in question, so it is possible we might have some links to update somewhere. Regards, Daniel
diff --git a/docs/system/build-platforms.rst b/docs/about/build-platforms.rst similarity index 100% rename from docs/system/build-platforms.rst rename to docs/about/build-platforms.rst diff --git a/docs/system/deprecated.rst b/docs/about/deprecated.rst similarity index 100% rename from docs/system/deprecated.rst rename to docs/about/deprecated.rst diff --git a/docs/about/index.rst b/docs/about/index.rst new file mode 100644 index 00000000000..cd44456a6bf --- /dev/null +++ b/docs/about/index.rst @@ -0,0 +1,10 @@ +About QEMU +========== + +.. toctree:: + :maxdepth: 2 + + build-platforms + deprecated + removed-features + license diff --git a/docs/system/license.rst b/docs/about/license.rst similarity index 100% rename from docs/system/license.rst rename to docs/about/license.rst diff --git a/docs/system/removed-features.rst b/docs/about/removed-features.rst similarity index 100% rename from docs/system/removed-features.rst rename to docs/about/removed-features.rst diff --git a/docs/index.rst b/docs/index.rst index 763e3d0426e..5f7eaaa632c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,6 +10,7 @@ Welcome to QEMU's documentation! :maxdepth: 2 :caption: Contents: + about/index system/index user/index tools/index diff --git a/docs/system/index.rst b/docs/system/index.rst index 058cabd36cc..fda4b1b7054 100644 --- a/docs/system/index.rst +++ b/docs/system/index.rst @@ -35,7 +35,3 @@ or Hypervisor.Framework. targets security multi-process - deprecated - removed-features - build-platforms - license
Now that we have a single Sphinx manual rather than multiple manuals, we can provide a better place for "common to all of QEMU" information like the deprecation notices, build platforms, license information, which we currently have in the system/ manual even though it applies to all of QEMU. Create a new directory about/ on the same level as system/, user/, etc, and move these documents there. Signed-off-by: Peter Maydell <peter.maydell@linaro.org> --- docs/{system => about}/build-platforms.rst | 0 docs/{system => about}/deprecated.rst | 0 docs/about/index.rst | 10 ++++++++++ docs/{system => about}/license.rst | 0 docs/{system => about}/removed-features.rst | 0 docs/index.rst | 1 + docs/system/index.rst | 4 ---- 7 files changed, 11 insertions(+), 4 deletions(-) rename docs/{system => about}/build-platforms.rst (100%) rename docs/{system => about}/deprecated.rst (100%) create mode 100644 docs/about/index.rst rename docs/{system => about}/license.rst (100%) rename docs/{system => about}/removed-features.rst (100%)