[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-commits] [qemu/qemu] 091479: qemu-doc: convert user-mode emulation
|
From: |
Peter Maydell |
|
Subject: |
[Qemu-commits] [qemu/qemu] 091479: qemu-doc: convert user-mode emulation to a separat... |
|
Date: |
Fri, 06 Mar 2020 04:00:15 -0800 |
Branch: refs/heads/master
Home: https://github.com/qemu/qemu
Commit: 091479301f96d0e1df0ab12f18d1b265979cba47
https://github.com/qemu/qemu/commit/091479301f96d0e1df0ab12f18d1b265979cba47
Author: Paolo Bonzini <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M Makefile
M docs/index.html.in
M docs/index.rst
A docs/user/conf.py
A docs/user/index.rst
A docs/user/main.rst
M qemu-doc.texi
Log Message:
-----------
qemu-doc: convert user-mode emulation to a separate Sphinx manual
The final addition to the set of QEMU manuals is the user-mode emulation
manual, which right now is included in qemu-doc.texi. Extract it and
convert it to rST, so that qemu-doc.texi covers only full system emulation.
Signed-off-by: Paolo Bonzini <address@hidden>
Reviewed-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Message-id: address@hidden
Message-id: address@hidden
[PMM: Fix makefile conflicts; add user manual to
index.rst and index.html.in; don't specify empty man_pages
list; fixed a few comments to say 'user' rather than 'system']
Reviewed-by: Peter Maydell <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Commit: a6bd8b0a56f3fdf3c46775b458e3df3c25d0b752
https://github.com/qemu/qemu/commit/a6bd8b0a56f3fdf3c46775b458e3df3c25d0b752
Author: Paolo Bonzini <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M qemu-doc.texi
Log Message:
-----------
qemu-doc: remove target OS documentation
This section covers OSes up to Windows 2000, and as such it is mostly
obsolete. Zap it.
Reviewed-by: Peter Maydell <address@hidden>
Signed-off-by: Paolo Bonzini <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Message-id: address@hidden
Message-id: address@hidden
Signed-off-by: Peter Maydell <address@hidden>
Commit: 41955e1b6f99e4db521f99fd27c74705b59f67e0
https://github.com/qemu/qemu/commit/41955e1b6f99e4db521f99fd27c74705b59f67e0
Author: Paolo Bonzini <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M scripts/texi2pod.pl
Log Message:
-----------
texi2pod: parse @include directives outside "@c man" blocks
This enables splitting the huge qemu-doc.texi file and keeping parallel
Texinfo and rST versions of the documentation. texi2pod is not going to
live much longer and hardly anyone cares about its upstream status,
so the temporary fork should be acceptable.
Signed-off-by: Paolo Bonzini <address@hidden>
Reviewed-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Message-id: address@hidden
Message-id: address@hidden
Reviewed-by: Peter Maydell <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Commit: 5600d275d52aa822393edd8b52b397dfff8a499c
https://github.com/qemu/qemu/commit/5600d275d52aa822393edd8b52b397dfff8a499c
Author: Paolo Bonzini <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M MAINTAINERS
M Makefile
R docs/qemu-cpu-models.texi
A docs/system/cpu-models-mips.texi
A docs/system/cpu-models-x86.texi
A docs/system/qemu-cpu-models.texi
M qemu-doc.texi
Log Message:
-----------
qemu-doc: split CPU models doc between MIPS and x86 parts
The MIPS CPU models end up in the middle of the PC documentation. Move
them to a separate file so that they can be placed in the right section.
The man page still includes both x86 and MIPS content.
Signed-off-by: Paolo Bonzini <address@hidden>
Reviewed-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Message-id: address@hidden
Message-id: address@hidden
Reviewed-by: Peter Maydell <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Commit: fdeccf932d05c527b3ea57207a03392d15001b73
https://github.com/qemu/qemu/commit/fdeccf932d05c527b3ea57207a03392d15001b73
Author: Paolo Bonzini <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M Makefile
A docs/system/build-platforms.texi
A docs/system/gdb.texi
A docs/system/images.texi
A docs/system/invocation.texi
A docs/system/ivshmem.texi
A docs/system/keys.texi
A docs/system/license.texi
A docs/system/linuxboot.texi
A docs/system/monitor.texi
A docs/system/mux-chardev.texi
A docs/system/net.texi
A docs/system/quickstart.texi
A docs/system/tls.texi
A docs/system/usb.texi
A docs/system/vnc-security.texi
M qemu-doc.texi
Log Message:
-----------
qemu-doc: split qemu-doc.texi in multiple files
In order to facilitate the reorganization of qemu-doc.texi content,
as well as the conversion to rST/Sphinx, split it in multiple .texi
files that are included from docs/system.
The "other devices" section is renamed to ivshmem and placed last.
Signed-off-by: Paolo Bonzini <address@hidden>
Reviewed-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Message-id: address@hidden
Message-id: address@hidden
Reviewed-by: Peter Maydell <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Commit: ce9fc5834c74a9e1b2ad2f51324cd1f0d5a13335
https://github.com/qemu/qemu/commit/ce9fc5834c74a9e1b2ad2f51324cd1f0d5a13335
Author: Paolo Bonzini <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M docs/system/quickstart.texi
M qemu-doc.texi
Log Message:
-----------
qemu-doc: extract common system emulator documentation from the PC section
Move the section on PC peripherals together with other targets.
While some x86-specific information remains in the main system
emulation chapter, it can be tackled more easily a section at a
time.
Signed-off-by: Paolo Bonzini <address@hidden>
Reviewed-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Message-id: address@hidden
Message-id: address@hidden
Reviewed-by: Peter Maydell <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Commit: 0a3716060f7dd7dcdcbffe12197a9fb8ca371a0f
https://github.com/qemu/qemu/commit/0a3716060f7dd7dcdcbffe12197a9fb8ca371a0f
Author: Paolo Bonzini <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M qemu-doc.texi
Log Message:
-----------
qemu-doc: move system requirements chapter inside PC section
The system requirements documented in this chapter are limited to x86 KVM
targets.
Clean them up and move them to the target section.
Signed-off-by: Paolo Bonzini <address@hidden>
Reviewed-by: Peter Maydell <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Message-id: address@hidden
Message-id: address@hidden
Reviewed-by: Peter Maydell <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Commit: 9d0ba2cd943a8baa1b29380308e53095843415cc
https://github.com/qemu/qemu/commit/9d0ba2cd943a8baa1b29380308e53095843415cc
Author: Paolo Bonzini <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
A docs/system/target-arm.texi
A docs/system/target-i386.texi
A docs/system/target-m68k.texi
A docs/system/target-mips.texi
A docs/system/target-ppc.texi
A docs/system/target-sparc.texi
A docs/system/target-sparc64.texi
A docs/system/target-xtensa.texi
M qemu-doc.texi
Log Message:
-----------
qemu-doc: split target sections to separate files
Signed-off-by: Paolo Bonzini <address@hidden>
Reviewed-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Message-id: address@hidden
Message-id: address@hidden
Reviewed-by: Peter Maydell <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Commit: e324ded0074e1dc884e4f9ae0f1d92be06b99294
https://github.com/qemu/qemu/commit/e324ded0074e1dc884e4f9ae0f1d92be06b99294
Author: Peter Maydell <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M qemu-tech.texi
Log Message:
-----------
qemu-doc: Remove the "CPU emulation" part of the "Implementation notes"
The "CPU emulation" part of the "Implementation notes" in
qemu-tech.texi looks like it is documenting what features of various
CPUs we do or don't emulate. However:
* it covers only six of our 21 guest architectures
* the last time anybody updated it for actual content was in
2011/2012 for Xtensa; the content for the other five
architectures is even older, being from 2008 or before!
What we have is out of date, misleading and incomplete.
Just delete this part of the document rather than trying to
convert it to rST.
(It would be nice eventually to have documentation of the
scope and limitations of our emulation; but we will want to
separate out the generic "system emulation" information from
the parts that are specific to linux-user anyway, as they will
be in different manuals.)
Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Signed-off-by: Paolo Bonzini <address@hidden>
Message-id: address@hidden
Message-id: address@hidden
Message-Id: <address@hidden>
Signed-off-by: Paolo Bonzini <address@hidden>
Commit: 2147106172266c3f38b167ead97bd17eeaab85a0
https://github.com/qemu/qemu/commit/2147106172266c3f38b167ead97bd17eeaab85a0
Author: Paolo Bonzini <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M Makefile
A docs/system/managed-startup.texi
M qemu-doc.texi
R qemu-tech.texi
Log Message:
-----------
qemu-doc: move qemu-tech.texi into main section
The only remaining content in qemu-tech.texi is a few paragraphs
about managed start up options. Move them in the main section
about full system emulation.
Signed-off-by: Paolo Bonzini <address@hidden>
Reviewed-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Message-id: address@hidden
Message-id: address@hidden
Reviewed-by: Peter Maydell <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Commit: abcd92db6a7b725e16826ee2e3fcb13cfe3a96c2
https://github.com/qemu/qemu/commit/abcd92db6a7b725e16826ee2e3fcb13cfe3a96c2
Author: Paolo Bonzini <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M MAINTAINERS
M Makefile
R docs/security.texi
A docs/system/deprecated.texi
A docs/system/qemu-option-trace.texi
A docs/system/security.texi
R qemu-deprecated.texi
M qemu-doc.texi
R qemu-option-trace.texi
M qemu-options.hx
Log Message:
-----------
qemu-doc: move included files to docs/system
Since qemu-doc.texi is mostly including files from docs/system,
move the existing include files there for consistency.
Signed-off-by: Paolo Bonzini <address@hidden>
Reviewed-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Message-id: address@hidden
Message-id: address@hidden
[PMM: update MAINTAINERS line for qemu-option-trace.texi]
Reviewed-by: Peter Maydell <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Commit: c9a38ce6abf7d5f1c6a64237cead9b298d03c118
https://github.com/qemu/qemu/commit/c9a38ce6abf7d5f1c6a64237cead9b298d03c118
Author: Paolo Bonzini <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M docs/system/keys.texi
M docs/system/monitor.texi
M docs/system/mux-chardev.texi
M docs/system/quickstart.texi
M docs/system/target-arm.texi
M docs/system/target-i386.texi
M docs/system/target-m68k.texi
M docs/system/target-mips.texi
M docs/system/target-ppc.texi
M docs/system/target-sparc.texi
M docs/system/target-sparc64.texi
M docs/system/target-xtensa.texi
M qemu-doc.texi
Log Message:
-----------
qemu-doc: remove indices other than findex
These indices are not well-maintained, and pandoc also chokes on the
directives. Just nuke them.
Signed-off-by: Paolo Bonzini <address@hidden>
Reviewed-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Message-id: address@hidden
Message-id: address@hidden
Reviewed-by: Peter Maydell <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Commit: bccb135e54f746c8e18dc6146c1a678dc670a05c
https://github.com/qemu/qemu/commit/bccb135e54f746c8e18dc6146c1a678dc670a05c
Author: Paolo Bonzini <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M docs/system/index.rst
M docs/system/qemu-block-drivers.rst
A docs/system/qemu-block-drivers.rst.inc
Log Message:
-----------
docs/system: put qemu-block-drivers body in an included file
This removes the "only" directives, and lets us use the conventional
"DESCRIPTION" section in the manpage.
This temporarily drops the qemu-block-drivers documentation
from the system manual, but it will be put back (in the
right place in the toctree) in a later commit.
Signed-off-by: Paolo Bonzini <address@hidden>
Reviewed-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Message-id: address@hidden
Message-id: address@hidden
Reviewed-by: Peter Maydell <address@hidden>
[PMM: Added commit message note about temporarily losing
qemu-block-drivers from the system manual]
Signed-off-by: Peter Maydell <address@hidden>
Commit: de1572ca4902c057b100d5c3434f254dfc677ddd
https://github.com/qemu/qemu/commit/de1572ca4902c057b100d5c3434f254dfc677ddd
Author: Peter Maydell <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M Makefile
M docs/conf.py
A docs/defs.rst.inc
M docs/system/qemu-block-drivers.rst
Log Message:
-----------
docs: Create defs.rst.inc as a place to define substitutions
Rather than accumulating generally useful rST substitution
definitions in individual rST files, create a defs.rst.inc where we
can define these. To start with it has the |qemu_system| definition
from qemu-block-drivers.rst.
Add a comment noting a pitfall where putting literal markup in the
definition of |qemu_system| makes it misrender manpage output; this
means the point-of-use must handle the literal markup (which is
almost always done by having it inside a parsed-literal block).
Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Kashyap Chamarthy <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Message-id: address@hidden
Commit: 1bf84a1e2e8f3262c63469b11fb641fcc9747e6a
https://github.com/qemu/qemu/commit/1bf84a1e2e8f3262c63469b11fb641fcc9747e6a
Author: Kashyap Chamarthy <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M MAINTAINERS
M Makefile
M docs/system/conf.py
A docs/system/cpu-models-mips.rst.inc
A docs/system/cpu-models-x86.rst.inc
A docs/system/qemu-cpu-models.rst
R docs/system/qemu-cpu-models.texi
Log Message:
-----------
docs/system: Convert qemu-cpu-models.texi to rST
This doc was originally written by Daniel P. Berrangé
<address@hidden>, introduced via commit[1]: 2544e9e4aa (docs: add
guidance on configuring CPU models for x86, 2018-06-27).
In this patch:
- 1-1 conversion of Texinfo to rST, besides a couple of minor
tweaks that are too trivial to mention. (Thanks to Stephen
Finucane on IRC for the suggestion to use rST "definition lists"
instead of bullets in some places.)
Further modifications will be done via a separate patch.
- rST and related infra changes: manual page generation, Makefile
fixes, clean up references to qemu-cpu-models.texi, update year in
the copyright notice, etc.
[1] https://git.qemu.org/?p=qemu.git;a=commit;h=2544e9e4aa
As part of the conversion, we use a more generic 'author' attribution
for the manpage than we previously had, as agreed with the original
author Dan Berrange.
Signed-off-by: Kashyap Chamarthy <address@hidden>
Signed-off-by: Paolo Bonzini <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Message-id: address@hidden
Message-id: address@hidden
[Move macros to defs.rst.inc, split in x86 and MIPS parts,
make qemu-cpu-models.rst a standalone document. - Paolo]
Signed-off-by: Paolo Bonzini <address@hidden>
[PMM: Move defs.rst.inc setup to its own commit;
fix minor issues with MAINTAINERS file updates;
drop copyright date change; keep capitalization of
"QEMU Project developers" consistent with other uses;
minor Makefile fixups]
Signed-off-by: Peter Maydell <address@hidden>
Commit: c02c112a2ca66da9bf0843d428e27eac5107b365
https://github.com/qemu/qemu/commit/c02c112a2ca66da9bf0843d428e27eac5107b365
Author: Peter Maydell <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M docs/system/index.rst
A docs/system/security.rst
Log Message:
-----------
docs/system: Convert security.texi to rST format
security.texi is included from qemu-doc.texi but is not used
in the qemu.1 manpage. So we can do a straightforward conversion
of the contents, which go into the system manual.
Signed-off-by: Peter Maydell <address@hidden>
Signed-off-by: Paolo Bonzini <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Message-id: address@hidden
Message-id: address@hidden
Commit: 2f4325df9e82507c7d55d1c7e2c72f2fdaf0237a
https://github.com/qemu/qemu/commit/2f4325df9e82507c7d55d1c7e2c72f2fdaf0237a
Author: Peter Maydell <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M docs/system/index.rst
A docs/system/managed-startup.rst
Log Message:
-----------
docs/system: convert managed startup to rST.
Fix one typo in the process and format more option and
command names as literal text, but make no significant
changes to the content.
Signed-off-by: Peter Maydell <address@hidden>
Signed-off-by: Paolo Bonzini <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Message-id: address@hidden
Message-id: address@hidden
Commit: 41fba1618b7a743740670f528ba409478678cc7c
https://github.com/qemu/qemu/commit/41fba1618b7a743740670f528ba409478678cc7c
Author: Peter Maydell <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
A docs/system/deprecated.rst
M docs/system/index.rst
Log Message:
-----------
docs/system: convert the documentation of deprecated features to rST.
We put the whole of this document into the system manual, though
technically a few parts of it apply to qemu-img or qemu-nbd which are
otherwise documented in tools/.
We only make formatting fixes, except for one use of 'appendix' which
we change to 'section' because this isn't an appendix in the Sphinx
manual.
Signed-off-by: Peter Maydell <address@hidden>
Signed-off-by: Paolo Bonzini <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Message-id: address@hidden
Message-id: address@hidden
Commit: 324b2298feab35533d44301cfdae332c086463cf
https://github.com/qemu/qemu/commit/324b2298feab35533d44301cfdae332c086463cf
Author: Paolo Bonzini <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M docs/defs.rst.inc
A docs/system/build-platforms.rst
A docs/system/gdb.rst
A docs/system/images.rst
M docs/system/index.rst
A docs/system/invocation.rst
A docs/system/ivshmem.rst
A docs/system/keys.rst
A docs/system/license.rst
A docs/system/linuxboot.rst
A docs/system/monitor.rst
A docs/system/mux-chardev.rst
A docs/system/net.rst
A docs/system/quickstart.rst
A docs/system/target-arm.rst
A docs/system/target-i386.rst
A docs/system/target-m68k.rst
A docs/system/target-mips.rst
A docs/system/target-ppc.rst
A docs/system/target-sparc.rst
A docs/system/target-sparc64.rst
A docs/system/target-xtensa.rst
A docs/system/targets.rst
A docs/system/tls.rst
A docs/system/usb.rst
A docs/system/vnc-security.rst
Log Message:
-----------
docs/system: convert Texinfo documentation to rST
Apart from targets.rst, which was written by hand, this is an automated
conversion obtained with the following command:
makeinfo --force -o - --docbook \
-D 'qemu_system_x86 QEMU_SYSTEM_X86_MACRO' \
-D 'qemu_system QEMU_SYSTEM_MACRO' \
$texi | pandoc -f docbook -t rst+smart | perl -e '
$/=undef;
$_ = <>;
s/^- − /- /gm;
s/QEMU_SYSTEM_MACRO/|qemu_system|/g;
s/QEMU_SYSTEM_X86_MACRO/|qemu_system_x86|/g;
s/(?=::\n\n +\|qemu)/.. parsed-literal/g;
s/:\n\n::$/::/gm;
print' > $rst
In addition, the following changes were made manually:
- target-i386.rst and target-mips.rst: replace CPU model documentation with
an include directive
- monitor.rst: replace the command section with a comment
- images.rst: add toctree
- target-arm.rst: Replace use of :math: (which Sphinx complains
about) with :sup:, and hide it behind |I2C| and |I2C| substitutions.
Content that is not @included remains exclusive to qemu-doc.texi.
Signed-off-by: Paolo Bonzini <address@hidden>
Reviewed-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Message-id: address@hidden
Message-id: address@hidden
[PMM: Fixed target-arm.rst use of :math:; remove out of date
note about images.rst from commit message; fixed expansion
of |qemu_system_x86|; use parsed-literal in invocation.rst
when we want to use |qemu_system_x86|; fix incorrect subsection
level for "OS requirements" in target-i386.rst; fix incorrect
syntax for making links to other sections of the manual]
Reviewed-by: Peter Maydell <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Commit: a6b30bcae6ebc71bae83e0ac7a5f0dfc93bb5b3e
https://github.com/qemu/qemu/commit/a6b30bcae6ebc71bae83e0ac7a5f0dfc93bb5b3e
Author: Peter Maydell <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M Makefile
M docs/system/monitor.rst
M hmp-commands.hx
Log Message:
-----------
hmp-commands.hx: Add rST documentation fragments
Add the rST versions of the documentation fragments. Once we've
converted fully from Texinfo to rST we can remove the ETEXI
fragments; for the moment we need both.
Since the only consumer of the hmp-commands hxtool documentation
is the HTML manual, all we need to do for the monitor command
documentation to appear in the Sphinx system manual is add the
one line that invokes the hxtool extension on the .hx file.
Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Message-id: address@hidden
Commit: a12e74cc5236e0ebe06d44e8e159e07c066ba842
https://github.com/qemu/qemu/commit/a12e74cc5236e0ebe06d44e8e159e07c066ba842
Author: Peter Maydell <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M Makefile
M docs/system/monitor.rst
M hmp-commands-info.hx
Log Message:
-----------
hmp-commands-info.hx: Add rST documentation fragments
Add the rST versions of the documentation fragments. Once we've
converted fully from Texinfo to rST we can remove the ETEXI
fragments; for the moment we need both.
Note that most of the SRST fragments are 2-space indented so that the
'info foo' documentation entries appear as a sublist under the 'info'
entry in the top level list.
Again, all we need to do to put the documentation in the Sphinx manual
is a one-line hxtool-doc invocation.
Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Message-id: address@hidden
Commit: 705f48cc221fea128abdcc334606931e971229e4
https://github.com/qemu/qemu/commit/705f48cc221fea128abdcc334606931e971229e4
Author: Peter Maydell <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M docs/sphinx/hxtool.py
Log Message:
-----------
doc/scripts/hxtool.py: Strip trailing ':' from DEFHEADING/ARCHHEADING
In hxtool files, section headings defined with the DEFHEADING
and ARCHHEADING macros have a trailing ':'
DEFHEADING(Standard options:)
This is for the benefit of the --help output. For consistency
with the rest of the rST documentation, strip any trailing ':'
when we construct headings with the Sphinx hxtool extension.
This makes the table of contents look neater.
This only affects generation of documentation from qemu-options.hx,
which we will start doing in a later commit.
Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Message-id: address@hidden
Commit: 44d79a6bd74b1e98394f456957f3c919c44cf4aa
https://github.com/qemu/qemu/commit/44d79a6bd74b1e98394f456957f3c919c44cf4aa
Author: Peter Maydell <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M docs/system/target-arm.rst
M docs/system/target-arm.texi
M docs/system/target-m68k.rst
M docs/system/target-m68k.texi
M docs/system/target-xtensa.rst
M docs/system/target-xtensa.texi
M qemu-options.hx
Log Message:
-----------
docs: Roll semihosting option information into qemu-options.hx
Currently the per-target documentation for those targets that
implement semihosting includes a bit of text that goes into both the
manual and the manpage about options specific to the target. This
text is redundant with the earlier generic option description of the
semihosting option produced from qemu-options.hx. To avoid having
to create a lot of stub include files to include into the rST
generated qemu.1 manpage, roll target-specific bits of information
into the qemu-options.hx text, so the user doesn't have to look
in two places for this information.
Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Message-id: address@hidden
Commit: 196afbb0949daf41c3742b5f1ac2173bb51a684e
https://github.com/qemu/qemu/commit/196afbb0949daf41c3742b5f1ac2173bb51a684e
Author: Peter Maydell <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M docs/system/target-ppc.rst
M docs/system/target-ppc.texi
M docs/system/target-sparc.rst
M docs/system/target-sparc.texi
M docs/system/target-sparc64.rst
M docs/system/target-sparc64.texi
M qemu-options.hx
Log Message:
-----------
docs: Roll -prom-env and -g target-specific info into qemu-options.hx
The SPARC and PPC targets currently have a fragment of target-specific
information about the -g and -prom options which would be better placed
as part of the general documentation of those options in qemu-options.hx.
Move the relevant information to those locations.
SPARC also has a bit of text about the -M option which is out of
date and provides no useful information over the generic documentation
of that option, so just delete it.
The motivation here is again to avoid having to awkwardly include
this text into the rST version of the qemu.1 manpage.
Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Message-id: address@hidden
Commit: 2b63ec5fb297016b642ad622a9f8f7ccffa5082b
https://github.com/qemu/qemu/commit/2b63ec5fb297016b642ad622a9f8f7ccffa5082b
Author: Peter Maydell <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
A scripts/hxtool-conv.pl
Log Message:
-----------
scripts/hxtool-conv: Archive script used in qemu-options.hx conversion
This commit archives the perl script used to do conversion of the
STEXI/ETEXI blocks in qemu-options.hx. (The other .hx files were
manually converted, but qemu-options.hx is complicated enough that
I felt I needed some scripting.)
Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Message-id: address@hidden
Commit: e2fcbf4263231f09723e60811c3419cf509225d6
https://github.com/qemu/qemu/commit/e2fcbf4263231f09723e60811c3419cf509225d6
Author: Peter Maydell <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M qemu-options.hx
Log Message:
-----------
qemu-options.hx: Add rST documentation fragments
Add the rST versions of the documentation fragments to qemu-options.hx.
This is entirely autogenerated using scripts/hxtool-conv.pl.
The result is not quite valid rST in all places; the following
commit will have the manual adjustments needed.
Signed-off-by: Peter Maydell <address@hidden>
Commit: 09ce5f2d6bd6739144a9bcebd71115fb825371e6
https://github.com/qemu/qemu/commit/09ce5f2d6bd6739144a9bcebd71115fb825371e6
Author: Peter Maydell <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M Makefile
M docs/system/invocation.rst
M qemu-options.hx
Log Message:
-----------
qemu-options.hx: Fix up the autogenerated rST
This commit contains hand-written fixes for some issues with the
autogenerated rST fragments in qemu-options.hx:
* Sphinx complains about the UTF-8 art table in the documentation of
the -drive option. Replace it with a proper rST format table.
* rST does not like definition list entries with no actual
definition, but it is possible to work around this by putting a
single escaped literal space as the definition line.
* The "-g widthxheight" option documentation suffers particularly
badly from losing the distinction between italics and fixed-width
as a result of the auto conversion, so put it back in again.
* The script missed some places that use the |qemu_system| etc
macros and need to be marked up as parsed-literal blocks.
* The script autogenerated an expanded out version of the
contents of qemu-option-trace.texi; replace it with an
qemu-option-trace.rst.inc include.
This is sufficient that we can enable inclusion of the
option documentation from invocation.rst.
Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Message-id: address@hidden
Commit: bf87bef09197da1e25980438056f9494e1b7cb7d
https://github.com/qemu/qemu/commit/bf87bef09197da1e25980438056f9494e1b7cb7d
Author: Peter Maydell <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
A docs/system/device-url-syntax.rst.inc
M docs/system/invocation.rst
M docs/system/keys.rst
A docs/system/keys.rst.inc
M docs/system/mux-chardev.rst
A docs/system/mux-chardev.rst.inc
A docs/system/target-i386-desc.rst.inc
M docs/system/target-i386.rst
Log Message:
-----------
docs: Split out sections for the manpage into .rst.inc files
Sphinx doesn't have very good facilities for marking chunks
of documentation as "put this in the manpage only". So instead
we move the parts we want to put into both the HTML manuals
and the manpage into their own .rst.inc files, which we can
include from both the main manual rst files and a new toplevel
rst file that will be the skeleton of the qemu.1 manpage.
In this commit, just split out the parts of the documentation
that go in the manpage.
Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Message-id: address@hidden
Commit: d06118bfbd8c0ab5b665aee9e0561aa58d3e45e1
https://github.com/qemu/qemu/commit/d06118bfbd8c0ab5b665aee9e0561aa58d3e45e1
Author: Peter Maydell <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M Makefile
M docs/system/conf.py
A docs/system/qemu-manpage.rst
Log Message:
-----------
docs: Generate qemu.1 manpage with Sphinx
Generate the qemu.1 manpage using Sphinx; we do this with a new
top-level rst source file which is just the skeleton of the manpage
and which includes .rst.inc fragments where it needs to incorporate
sections from the larger HTML manuals.
Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Message-id: address@hidden
Commit: 1879f241e664a38455f2e3884dcc1c0bb994f671
https://github.com/qemu/qemu/commit/1879f241e664a38455f2e3884dcc1c0bb994f671
Author: Peter Maydell <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M ui/cocoa.m
Log Message:
-----------
ui/cocoa.m: Update documentation file and pathname
We want to stop generating the old qemu-doc.html; first we
must update places that refer to it so they instead go to
our top level index.html documentation landing page.
The Cocoa UI has a menu option to bring up the documentation;
make it point to the new top level index.html instead.
Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Message-id: address@hidden
Commit: 5b1d0e924955cb11090352b26810da1049ff3f22
https://github.com/qemu/qemu/commit/5b1d0e924955cb11090352b26810da1049ff3f22
Author: Peter Maydell <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M .gitignore
M Makefile
M docs/index.html.in
M docs/specs/ivshmem-spec.txt
Log Message:
-----------
docs: Stop building qemu-doc
Stop building the old texinfo qemu-doc; all its contents are
now available in the Sphinx-generated manuals and manpages.
Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Message-id: address@hidden
Commit: 3a8273b1ab3299cf92f7f72b41f56471ecb8e5cf
https://github.com/qemu/qemu/commit/3a8273b1ab3299cf92f7f72b41f56471ecb8e5cf
Author: Peter Maydell <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M MAINTAINERS
R docs/system/build-platforms.texi
R docs/system/cpu-models-mips.texi
R docs/system/cpu-models-x86.texi
R docs/system/deprecated.texi
R docs/system/gdb.texi
R docs/system/images.texi
R docs/system/invocation.texi
R docs/system/ivshmem.texi
R docs/system/keys.texi
R docs/system/license.texi
R docs/system/linuxboot.texi
R docs/system/managed-startup.texi
R docs/system/monitor.texi
R docs/system/mux-chardev.texi
R docs/system/net.texi
R docs/system/qemu-option-trace.texi
R docs/system/quickstart.texi
R docs/system/security.texi
R docs/system/target-arm.texi
R docs/system/target-i386.texi
R docs/system/target-m68k.texi
R docs/system/target-mips.texi
R docs/system/target-ppc.texi
R docs/system/target-sparc.texi
R docs/system/target-sparc64.texi
R docs/system/target-xtensa.texi
R docs/system/tls.texi
R docs/system/usb.texi
R docs/system/vnc-security.texi
R qemu-doc.texi
Log Message:
-----------
docs: Remove old texinfo sources
We can now delete the old .texi files, which we have been keeping in
the tree as a parallel set of documentation to the new rST sources.
The only remaining use of Texinfo is the autogenerated manuals
and HTML documents created from the QAPI JSON doc comments.
Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Reviewed-by: Kashyap Chamarthy <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Message-id: address@hidden
Commit: 29f9dff79073cfdc336466a950294be91b90f514
https://github.com/qemu/qemu/commit/29f9dff79073cfdc336466a950294be91b90f514
Author: Peter Maydell <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M hmp-commands-info.hx
M hmp-commands.hx
M qemu-options.hx
Log Message:
-----------
*.hx: Remove all the STEXI/ETEXI blocks
We no longer generate texinfo from the hxtool input files,
so delete all the STEXI/ETEXI blocks.
This commit was created using the following Perl one-liner:
perl -i -n -e '$suppress = 1,next if /^STEXI/;$suppress=0,next if /^ETEXI/;
print if !$suppress;' *.hx
Signed-off-by: Peter Maydell <address@hidden>
Commit: f4c4357fbfca0fb14e477bf661ae7384b4b9b283
https://github.com/qemu/qemu/commit/f4c4357fbfca0fb14e477bf661ae7384b4b9b283
Author: Peter Maydell <address@hidden>
Date: 2020-03-06 (Fri, 06 Mar 2020)
Changed paths:
M .gitignore
M MAINTAINERS
M Makefile
M docs/conf.py
A docs/defs.rst.inc
M docs/index.html.in
M docs/index.rst
R docs/qemu-cpu-models.texi
R docs/security.texi
M docs/specs/ivshmem-spec.txt
M docs/sphinx/hxtool.py
A docs/system/build-platforms.rst
M docs/system/conf.py
A docs/system/cpu-models-mips.rst.inc
A docs/system/cpu-models-x86.rst.inc
A docs/system/deprecated.rst
A docs/system/device-url-syntax.rst.inc
A docs/system/gdb.rst
A docs/system/images.rst
M docs/system/index.rst
A docs/system/invocation.rst
A docs/system/ivshmem.rst
A docs/system/keys.rst
A docs/system/keys.rst.inc
A docs/system/license.rst
A docs/system/linuxboot.rst
A docs/system/managed-startup.rst
A docs/system/monitor.rst
A docs/system/mux-chardev.rst
A docs/system/mux-chardev.rst.inc
A docs/system/net.rst
M docs/system/qemu-block-drivers.rst
A docs/system/qemu-block-drivers.rst.inc
A docs/system/qemu-cpu-models.rst
A docs/system/qemu-manpage.rst
A docs/system/quickstart.rst
A docs/system/security.rst
A docs/system/target-arm.rst
A docs/system/target-i386-desc.rst.inc
A docs/system/target-i386.rst
A docs/system/target-m68k.rst
A docs/system/target-mips.rst
A docs/system/target-ppc.rst
A docs/system/target-sparc.rst
A docs/system/target-sparc64.rst
A docs/system/target-xtensa.rst
A docs/system/targets.rst
A docs/system/tls.rst
A docs/system/usb.rst
A docs/system/vnc-security.rst
A docs/user/conf.py
A docs/user/index.rst
A docs/user/main.rst
M hmp-commands-info.hx
M hmp-commands.hx
R qemu-deprecated.texi
R qemu-doc.texi
R qemu-option-trace.texi
M qemu-options.hx
R qemu-tech.texi
A scripts/hxtool-conv.pl
M scripts/texi2pod.pl
M ui/cocoa.m
Log Message:
-----------
Merge remote-tracking branch 'remotes/pmaydell/tags/pull-docs-20200306' into
staging
docs:
* Convert qemu-doc from Texinfo to rST
# gpg: Signature made Fri 06 Mar 2020 11:08:15 GMT
# gpg: using RSA key E1A5C593CD419DE28E8315CF3C2525ED14360CDE
# gpg: issuer "address@hidden"
# gpg: Good signature from "Peter Maydell <address@hidden>" [ultimate]
# gpg: aka "Peter Maydell <address@hidden>" [ultimate]
# gpg: aka "Peter Maydell <address@hidden>" [ultimate]
# Primary key fingerprint: E1A5 C593 CD41 9DE2 8E83 15CF 3C25 25ED 1436 0CDE
* remotes/pmaydell/tags/pull-docs-20200306: (33 commits)
*.hx: Remove all the STEXI/ETEXI blocks
docs: Remove old texinfo sources
docs: Stop building qemu-doc
ui/cocoa.m: Update documentation file and pathname
docs: Generate qemu.1 manpage with Sphinx
docs: Split out sections for the manpage into .rst.inc files
qemu-options.hx: Fix up the autogenerated rST
qemu-options.hx: Add rST documentation fragments
scripts/hxtool-conv: Archive script used in qemu-options.hx conversion
docs: Roll -prom-env and -g target-specific info into qemu-options.hx
docs: Roll semihosting option information into qemu-options.hx
doc/scripts/hxtool.py: Strip trailing ':' from DEFHEADING/ARCHHEADING
hmp-commands-info.hx: Add rST documentation fragments
hmp-commands.hx: Add rST documentation fragments
docs/system: convert Texinfo documentation to rST
docs/system: convert the documentation of deprecated features to rST.
docs/system: convert managed startup to rST.
docs/system: Convert security.texi to rST format
docs/system: Convert qemu-cpu-models.texi to rST
docs: Create defs.rst.inc as a place to define substitutions
...
Signed-off-by: Peter Maydell <address@hidden>
Compare: https://github.com/qemu/qemu/compare/6b02fca71329...f4c4357fbfca
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Qemu-commits] [qemu/qemu] 091479: qemu-doc: convert user-mode emulation to a separat...,
Peter Maydell <=