qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: "Alex Bennée" <alex.bennee@linaro.org>
To: Peter Maydell <peter.maydell@linaro.org>
Cc: Paolo Bonzini <pbonzini@redhat.com>,
	qemu-devel@nongnu.org, Kashyap Chamarthy <kchamart@redhat.com>
Subject: Re: [PATCH v3 11/33] qemu-doc: move included files to docs/system
Date: Mon, 02 Mar 2020 11:31:34 +0000	[thread overview]
Message-ID: <87imjnat7t.fsf@linaro.org> (raw)
In-Reply-To: <20200228153619.9906-12-peter.maydell@linaro.org>


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

> From: Paolo Bonzini <pbonzini@redhat.com>
>
> 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>
> Message-id: 20200226113034.6741-12-pbonzini@redhat.com
> [PMM: update MAINTAINERS line for qemu-option-trace.texi]
> Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

Reviewed-by: Alex Bennée <alex.bennee@linaro.org>

> ---
>  Makefile                                                  | 8 ++++----
>  MAINTAINERS                                               | 5 +++--
>  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, 10 insertions(+), 9 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/Makefile b/Makefile
> index 56382a45936..7e60a435426 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -1110,7 +1110,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
> @@ -1120,8 +1120,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 \
> @@ -1140,7 +1139,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/MAINTAINERS b/MAINTAINERS
> index 8c6d8f533ce..74b025fb806 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -2232,7 +2232,7 @@ M: Stefan Hajnoczi <stefanha@redhat.com>
>  S: Maintained
>  F: trace/
>  F: trace-events
> -F: qemu-option-trace.texi
> +F: docs/system/qemu-option-trace.texi
>  F: scripts/tracetool.py
>  F: scripts/tracetool/
>  F: scripts/qemu-trace-stap*
> @@ -2802,7 +2802,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/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 e4bff7edbee..d3e743719ab 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 ac315c1ac45..5fbfa2797cb 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"


-- 
Alex Bennée


  reply	other threads:[~2020-03-02 11:32 UTC|newest]

Thread overview: 82+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
2020-02-28 15:35 ` [PATCH v3 01/33] qemu-doc: convert user-mode emulation to a separate Sphinx manual Peter Maydell
2020-03-02 11:05   ` Alex Bennée
2020-02-28 15:35 ` [PATCH v3 02/33] qemu-doc: remove target OS documentation Peter Maydell
2020-03-02 11:05   ` Alex Bennée
2020-02-28 15:35 ` [PATCH v3 03/33] texi2pod: parse @include directives outside "@c man" blocks Peter Maydell
2020-03-02 11:07   ` Alex Bennée
2020-02-28 15:35 ` [PATCH v3 04/33] qemu-doc: split CPU models doc between MIPS and x86 parts Peter Maydell
2020-03-02 11:18   ` Alex Bennée
2020-02-28 15:35 ` [PATCH v3 05/33] qemu-doc: split qemu-doc.texi in multiple files Peter Maydell
2020-03-02 11:22   ` Alex Bennée
2020-03-02 12:16     ` Peter Maydell
2020-03-02 14:18       ` Alex Bennée
2020-02-28 15:35 ` [PATCH v3 06/33] qemu-doc: extract common system emulator documentation from the PC section Peter Maydell
2020-03-02 11:25   ` Alex Bennée
2020-02-28 15:35 ` [PATCH v3 07/33] qemu-doc: move system requirements chapter inside " Peter Maydell
2020-02-28 15:35 ` [PATCH v3 08/33] qemu-doc: split target sections to separate files Peter Maydell
2020-03-02 11:28   ` Alex Bennée
2020-02-28 15:35 ` [PATCH v3 09/33] qemu-doc: Remove the "CPU emulation" part of the "Implementation notes" Peter Maydell
2020-03-02 11:30   ` Alex Bennée
2020-02-28 15:35 ` [PATCH v3 10/33] qemu-doc: move qemu-tech.texi into main section Peter Maydell
2020-03-02 11:31   ` Alex Bennée
2020-02-28 15:35 ` [PATCH v3 11/33] qemu-doc: move included files to docs/system Peter Maydell
2020-03-02 11:31   ` Alex Bennée [this message]
2020-02-28 15:35 ` [PATCH v3 12/33] qemu-doc: remove indices other than findex Peter Maydell
2020-03-02 11:32   ` Alex Bennée
2020-02-28 15:35 ` [PATCH v3 13/33] docs/system: put qemu-block-drivers body in an included file Peter Maydell
2020-03-02 11:32   ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 14/33] docs: Create defs.rst.inc as a place to define substitutions Peter Maydell
2020-03-02 12:40   ` Kashyap Chamarthy
2020-02-28 15:36 ` [PATCH v3 15/33] docs/system: Convert qemu-cpu-models.texi to rST Peter Maydell
2020-03-02 12:08   ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 16/33] docs/system: Convert security.texi to rST format Peter Maydell
2020-03-02 12:10   ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 17/33] docs/system: convert managed startup to rST Peter Maydell
2020-03-02 12:10   ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 18/33] docs/system: convert the documentation of deprecated features " Peter Maydell
2020-03-02 12:12   ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 19/33] docs/system: convert Texinfo documentation " Peter Maydell
2020-03-02 12:13   ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 20/33] hmp-commands.hx: Add rST documentation fragments Peter Maydell
2020-03-02 12:16   ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 21/33] hmp-commands-info.hx: " Peter Maydell
2020-03-02 12:16   ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 22/33] doc/scripts/hxtool.py: Strip trailing ':' from DEFHEADING/ARCHHEADING Peter Maydell
2020-03-02 12:17   ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 23/33] docs: Roll semihosting option information into qemu-options.hx Peter Maydell
2020-03-02 12:18   ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 24/33] docs: Roll -prom-env and -g target-specific info " Peter Maydell
2020-03-02 12:19   ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 25/33] scripts/hxtool-conv: Archive script used in qemu-options.hx conversion Peter Maydell
2020-03-02 12:19   ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 26/33] qemu-options.hx: Add rST documentation fragments Peter Maydell
2020-03-02 12:20   ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 27/33] qemu-options.hx: Fix up the autogenerated rST Peter Maydell
2020-03-02 12:23   ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 28/33] docs: Split out sections for the manpage into .rst.inc files Peter Maydell
2020-03-02 12:24   ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 29/33] docs: Generate qemu.1 manpage with Sphinx Peter Maydell
2020-03-02 12:24   ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 30/33] ui/cocoa.m: Update documentation file and pathname Peter Maydell
2020-03-02 12:28   ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 31/33] docs: Stop building qemu-doc Peter Maydell
2020-03-02 12:32   ` Alex Bennée
2020-03-11 14:53   ` Markus Armbruster
2020-03-11 15:15     ` Peter Maydell
2020-03-12  6:06       ` Markus Armbruster
2020-03-12 10:11         ` Peter Maydell
2020-03-12 13:16           ` Markus Armbruster
2020-02-28 15:36 ` [PATCH v3 32/33] docs: Remove old texinfo sources Peter Maydell
2020-03-02 12:34   ` Alex Bennée
2020-03-02 12:42   ` Kashyap Chamarthy
2020-02-28 15:36 ` [PATCH v3 33/33] *.hx: Remove all the STEXI/ETEXI blocks Peter Maydell
2020-03-02 12:36   ` Alex Bennée
2020-02-28 18:36 ` [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
2020-02-28 21:20   ` Stefan Weil
2020-02-29 11:50     ` Peter Maydell
2020-03-02 12:41 ` Alex Bennée
2020-03-03 17:35 ` Peter Maydell
2020-03-03 17:44   ` Paolo Bonzini
2020-03-03 18:19   ` Alex Bennée
2020-03-04  9:12   ` Kashyap Chamarthy

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87imjnat7t.fsf@linaro.org \
    --to=alex.bennee@linaro.org \
    --cc=kchamart@redhat.com \
    --cc=pbonzini@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-devel@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).