[PATCH 11/18] qemu-doc: move included files to docs/system

Paolo Bonzini posted 18 patches 5 years, 7 months ago
[PATCH 11/18] qemu-doc: move included files to docs/system
Posted by Paolo Bonzini 5 years, 7 months ago
Since qemu-doc.texi is mostly including files from docs/system,
move the existing include files there for consistency.

Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---
 MAINTAINERS                                               | 3 ++-
 Makefile                                                  | 8 ++++----
 qemu-deprecated.texi => docs/system/deprecated.texi       | 0
 .../system/qemu-option-trace.texi                         | 0
 docs/{ => system}/security.texi                           | 0
 qemu-doc.texi                                             | 4 ++--
 qemu-options.hx                                           | 2 +-
 7 files changed, 9 insertions(+), 8 deletions(-)
 rename qemu-deprecated.texi => docs/system/deprecated.texi (100%)
 rename qemu-option-trace.texi => docs/system/qemu-option-trace.texi (100%)
 rename docs/{ => system}/security.texi (100%)

diff --git a/MAINTAINERS b/MAINTAINERS
index 574b80498c..0d3ee8bdc6 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -2796,7 +2796,8 @@ F: contrib/gitdm/*
 
 Incompatible changes
 R: libvir-list@redhat.com
-F: qemu-deprecated.texi
+F: docs/system/deprecated.texi
+F: docs/system/deprecated.rst
 
 Build System
 ------------
diff --git a/Makefile b/Makefile
index c36971fd39..6b5193b838 100644
--- a/Makefile
+++ b/Makefile
@@ -1103,7 +1103,7 @@ docs/interop/qemu-ga-qapi.texi: qga/qapi-generated/qga-qapi-doc.texi
 	@cp -p $< $@
 
 qemu.1: qemu-doc.texi qemu-options.texi qemu-monitor.texi qemu-monitor-info.texi
-qemu.1: qemu-option-trace.texi
+qemu.1: docs/system/qemu-option-trace.texi
 docs/system/qemu-cpu-models.7: docs/system/qemu-cpu-models.texi docs/system/cpu-models-x86.texi docs/system/cpu-models-mips.texi
 
 html: qemu-doc.html docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-ref.html sphinxdocs
@@ -1113,8 +1113,7 @@ txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt
 
 qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.txt: \
 	qemu-options.texi \
-	qemu-option-trace.texi \
-	qemu-deprecated.texi qemu-monitor.texi \
+	qemu-monitor.texi \
 	qemu-monitor-info.texi \
         docs/system/quickstart.texi \
         docs/system/invocation.texi \
@@ -1133,7 +1132,8 @@ qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.txt: \
         docs/system/build-platforms.texi \
         docs/system/license.texi \
 	docs/system/cpu-models-x86.texi docs/system/cpu-models-mips.texi \
-	docs/security.texi
+	docs/system/deprecated.texi docs/system/qemu-option-trace.texi \
+	docs/system/security.texi
 
 docs/interop/qemu-ga-ref.dvi docs/interop/qemu-ga-ref.html \
     docs/interop/qemu-ga-ref.info docs/interop/qemu-ga-ref.pdf \
diff --git a/qemu-deprecated.texi b/docs/system/deprecated.texi
similarity index 100%
rename from qemu-deprecated.texi
rename to docs/system/deprecated.texi
diff --git a/qemu-option-trace.texi b/docs/system/qemu-option-trace.texi
similarity index 100%
rename from qemu-option-trace.texi
rename to docs/system/qemu-option-trace.texi
diff --git a/docs/security.texi b/docs/system/security.texi
similarity index 100%
rename from docs/security.texi
rename to docs/system/security.texi
diff --git a/qemu-doc.texi b/qemu-doc.texi
index e4bff7edbe..d3e743719a 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -189,9 +189,9 @@ various targets are mentioned in the following sections.
 @include docs/system/target-m68k.texi
 @include docs/system/target-xtensa.texi
 
-@include docs/security.texi
+@include docs/system/security.texi
 
-@include qemu-deprecated.texi
+@include docs/system/deprecated.texi
 
 @include docs/system/build-platforms.texi
 
diff --git a/qemu-options.hx b/qemu-options.hx
index ac315c1ac4..5fbfa2797c 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -4221,7 +4221,7 @@ HXCOMM This line is not accurate, as some sub-options are backend-specific but
 HXCOMM HX does not support conditional compilation of text.
 @item -trace [[enable=]@var{pattern}][,events=@var{file}][,file=@var{file}]
 @findex -trace
-@include qemu-option-trace.texi
+@include docs/system/qemu-option-trace.texi
 ETEXI
 DEF("plugin", HAS_ARG, QEMU_OPTION_plugin,
     "-plugin [file=]<file>[,arg=<string>]\n"
-- 
2.21.1



Re: [PATCH 11/18] qemu-doc: move included files to docs/system
Posted by Peter Maydell 5 years, 7 months ago
On Wed, 26 Feb 2020 at 11:30, Paolo Bonzini <pbonzini@redhat.com> wrote:
>
> Since qemu-doc.texi is mostly including files from docs/system,
> move the existing include files there for consistency.
>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> ---
>  MAINTAINERS                                               | 3 ++-
>  Makefile                                                  | 8 ++++----
>  qemu-deprecated.texi => docs/system/deprecated.texi       | 0
>  .../system/qemu-option-trace.texi                         | 0
>  docs/{ => system}/security.texi                           | 0
>  qemu-doc.texi                                             | 4 ++--
>  qemu-options.hx                                           | 2 +-
>  7 files changed, 9 insertions(+), 8 deletions(-)
>  rename qemu-deprecated.texi => docs/system/deprecated.texi (100%)
>  rename qemu-option-trace.texi => docs/system/qemu-option-trace.texi (100%)
>  rename docs/{ => system}/security.texi (100%)
>
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 574b80498c..0d3ee8bdc6 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -2796,7 +2796,8 @@ F: contrib/gitdm/*
>
>  Incompatible changes
>  R: libvir-list@redhat.com
> -F: qemu-deprecated.texi
> +F: docs/system/deprecated.texi
> +F: docs/system/deprecated.rst
>

There's also an F: line for qemu-option-trace.texi that needs updating.

Otherwise
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>

thanks
-- PMM