From: Peter Maydell <peter.maydell@linaro.org>
To: qemu-devel@nongnu.org
Subject: [PULL 24/33] docs: Roll -prom-env and -g target-specific info into qemu-options.hx
Date: Fri, 6 Mar 2020 11:09:50 +0000 [thread overview]
Message-ID: <20200306110959.29461-25-peter.maydell@linaro.org> (raw)
In-Reply-To: <20200306110959.29461-1-peter.maydell@linaro.org>
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 <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
Tested-by: Alex Bennée <alex.bennee@linaro.org>
Message-id: 20200228153619.9906-25-peter.maydell@linaro.org
---
docs/system/target-ppc.rst | 14 --------------
docs/system/target-ppc.texi | 25 -------------------------
docs/system/target-sparc.rst | 19 -------------------
docs/system/target-sparc.texi | 27 ---------------------------
docs/system/target-sparc64.rst | 12 ------------
docs/system/target-sparc64.texi | 22 ----------------------
qemu-options.hx | 19 +++++++++++++++++++
7 files changed, 19 insertions(+), 119 deletions(-)
diff --git a/docs/system/target-ppc.rst b/docs/system/target-ppc.rst
index 43fadf3c00b..a2f04c533c2 100644
--- a/docs/system/target-ppc.rst
+++ b/docs/system/target-ppc.rst
@@ -43,19 +43,5 @@ the g3beige and mac99 PowerMac and the 40p machines. OpenBIOS is a free
(GPL v2) portable firmware implementation. The goal is to implement a
100% IEEE 1275-1994 (referred to as Open Firmware) compliant firmware.
-The following options are specific to the PowerPC emulation:
-
-``-g WxH[xDEPTH]``
- Set the initial VGA graphic mode. The default is 800x600x32.
-
-``-prom-env string``
- Set OpenBIOS variables in NVRAM, for example:
-
- ::
-
- qemu-system-ppc -prom-env 'auto-boot?=false' \
- -prom-env 'boot-device=hd:2,\yaboot' \
- -prom-env 'boot-args=conf=hd:2,\yaboot.conf'
-
More information is available at
http://perso.magic.fr/l_indien/qemu-ppc/.
diff --git a/docs/system/target-ppc.texi b/docs/system/target-ppc.texi
index 55f98f65b12..5c83d4f68e7 100644
--- a/docs/system/target-ppc.texi
+++ b/docs/system/target-ppc.texi
@@ -47,31 +47,6 @@ for the g3beige and mac99 PowerMac and the 40p machines. OpenBIOS is a free
(GPL v2) portable firmware implementation. The goal is to implement a 100%
IEEE 1275-1994 (referred to as Open Firmware) compliant firmware.
-@c man begin OPTIONS
-
-The following options are specific to the PowerPC emulation:
-
-@table @option
-
-@item -g @var{W}x@var{H}[x@var{DEPTH}]
-
-Set the initial VGA graphic mode. The default is 800x600x32.
-
-@item -prom-env @var{string}
-
-Set OpenBIOS variables in NVRAM, for example:
-
-@example
-qemu-system-ppc -prom-env 'auto-boot?=false' \
- -prom-env 'boot-device=hd:2,\yaboot' \
- -prom-env 'boot-args=conf=hd:2,\yaboot.conf'
-@end example
-
-@end table
-
-@c man end
-
-
More information is available at
@url{http://perso.magic.fr/l_indien/qemu-ppc/}.
diff --git a/docs/system/target-sparc.rst b/docs/system/target-sparc.rst
index 589c88d1756..b55f8d09e9c 100644
--- a/docs/system/target-sparc.rst
+++ b/docs/system/target-sparc.rst
@@ -60,22 +60,3 @@ QEMU web site. There are still issues with NetBSD and OpenBSD, but most
kernel versions work. Please note that currently older Solaris kernels
don't work probably due to interface issues between OpenBIOS and
Solaris.
-
-The following options are specific to the Sparc32 emulation:
-
-``-g WxHx[xDEPTH]``
- Set the initial graphics mode. For TCX, the default is 1024x768x8
- with the option of 1024x768x24. For cgthree, the default is
- 1024x768x8 with the option of 1152x900x8 for people who wish to use
- OBP.
-
-``-prom-env string``
- Set OpenBIOS variables in NVRAM, for example:
-
- ::
-
- qemu-system-sparc -prom-env 'auto-boot?=false' \
- -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single'
-
-``-M [SS-4|SS-5|SS-10|SS-20|SS-600MP|LX|Voyager|SPARCClassic] [|SPARCbook]``
- Set the emulated machine type. Default is SS-5.
diff --git a/docs/system/target-sparc.texi b/docs/system/target-sparc.texi
index 7748001f734..99fbf820b42 100644
--- a/docs/system/target-sparc.texi
+++ b/docs/system/target-sparc.texi
@@ -64,32 +64,5 @@ most kernel versions work. Please note that currently older Solaris kernels
don't work probably due to interface issues between OpenBIOS and
Solaris.
-@c man begin OPTIONS
-
-The following options are specific to the Sparc32 emulation:
-
-@table @option
-
-@item -g @var{W}x@var{H}x[x@var{DEPTH}]
-
-Set the initial graphics mode. For TCX, the default is 1024x768x8 with the
-option of 1024x768x24. For cgthree, the default is 1024x768x8 with the option
-of 1152x900x8 for people who wish to use OBP.
-
-@item -prom-env @var{string}
-
-Set OpenBIOS variables in NVRAM, for example:
-
-@example
-qemu-system-sparc -prom-env 'auto-boot?=false' \
- -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single'
-@end example
-
-@item -M [SS-4|SS-5|SS-10|SS-20|SS-600MP|LX|Voyager|SPARCClassic] [|SPARCbook]
-
-Set the emulated machine type. Default is SS-5.
-
-@end table
-
@c man end
diff --git a/docs/system/target-sparc64.rst b/docs/system/target-sparc64.rst
index ca76ba9c488..97e334b9308 100644
--- a/docs/system/target-sparc64.rst
+++ b/docs/system/target-sparc64.rst
@@ -35,15 +35,3 @@ QEMU emulates the following peripherals:
- 2 PCI IDE interfaces with hard disk and CD-ROM support
- Floppy disk
-
-The following options are specific to the Sparc64 emulation:
-
-``-prom-env string``
- Set OpenBIOS variables in NVRAM, for example:
-
- ::
-
- qemu-system-sparc64 -prom-env 'auto-boot?=false'
-
-``-M [sun4u|sun4v|niagara]``
- Set the emulated machine type. The default is sun4u.
diff --git a/docs/system/target-sparc64.texi b/docs/system/target-sparc64.texi
index 4db4ca3842b..d381d3af719 100644
--- a/docs/system/target-sparc64.texi
+++ b/docs/system/target-sparc64.texi
@@ -36,25 +36,3 @@ PC-compatible serial ports
Floppy disk
@end itemize
-@c man begin OPTIONS
-
-The following options are specific to the Sparc64 emulation:
-
-@table @option
-
-@item -prom-env @var{string}
-
-Set OpenBIOS variables in NVRAM, for example:
-
-@example
-qemu-system-sparc64 -prom-env 'auto-boot?=false'
-@end example
-
-@item -M [sun4u|sun4v|niagara]
-
-Set the emulated machine type. The default is sun4u.
-
-@end table
-
-@c man end
-
diff --git a/qemu-options.hx b/qemu-options.hx
index 753bfce411d..44366909719 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -1962,6 +1962,13 @@ STEXI
@item -g @var{width}x@var{height}[x@var{depth}]
@findex -g
Set the initial graphical resolution and depth (PPC, SPARC only).
+
+For PPC the default is 800x600x32.
+
+For SPARC with the TCX graphics device, the default is 1024x768x8 with the
+option of 1024x768x24. For cgthree, the default is 1024x768x8 with the option
+of 1152x900x8 for people who wish to use OBP.
+
ETEXI
DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
@@ -4107,6 +4114,18 @@ STEXI
@item -prom-env @var{variable}=@var{value}
@findex -prom-env
Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
+
+@example
+qemu-system-sparc -prom-env 'auto-boot?=false' \
+ -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single'
+@end example
+
+@example
+qemu-system-ppc -prom-env 'auto-boot?=false' \
+ -prom-env 'boot-device=hd:2,\yaboot' \
+ -prom-env 'boot-args=conf=hd:2,\yaboot.conf'
+@end example
+
ETEXI
DEF("semihosting", 0, QEMU_OPTION_semihosting,
"-semihosting semihosting mode\n",
--
2.20.1
next prev parent reply other threads:[~2020-03-06 11:23 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-03-06 11:09 [PULL 00/33] docs queue Peter Maydell
2020-03-06 11:09 ` [PULL 01/33] qemu-doc: convert user-mode emulation to a separate Sphinx manual Peter Maydell
2020-03-06 11:09 ` [PULL 02/33] qemu-doc: remove target OS documentation Peter Maydell
2020-03-06 11:09 ` [PULL 03/33] texi2pod: parse @include directives outside "@c man" blocks Peter Maydell
2020-03-06 11:09 ` [PULL 04/33] qemu-doc: split CPU models doc between MIPS and x86 parts Peter Maydell
2020-03-06 11:09 ` [PULL 05/33] qemu-doc: split qemu-doc.texi in multiple files Peter Maydell
2020-03-06 11:09 ` [PULL 06/33] qemu-doc: extract common system emulator documentation from the PC section Peter Maydell
2020-03-06 11:09 ` [PULL 07/33] qemu-doc: move system requirements chapter inside " Peter Maydell
2020-03-06 11:09 ` [PULL 08/33] qemu-doc: split target sections to separate files Peter Maydell
2020-03-06 11:09 ` [PULL 09/33] qemu-doc: Remove the "CPU emulation" part of the "Implementation notes" Peter Maydell
2020-03-06 11:09 ` [PULL 10/33] qemu-doc: move qemu-tech.texi into main section Peter Maydell
2020-03-06 11:09 ` [PULL 11/33] qemu-doc: move included files to docs/system Peter Maydell
2020-03-06 11:09 ` [PULL 12/33] qemu-doc: remove indices other than findex Peter Maydell
2020-03-06 11:09 ` [PULL 13/33] docs/system: put qemu-block-drivers body in an included file Peter Maydell
2020-03-06 11:09 ` [PULL 14/33] docs: Create defs.rst.inc as a place to define substitutions Peter Maydell
2020-03-06 11:09 ` [PULL 15/33] docs/system: Convert qemu-cpu-models.texi to rST Peter Maydell
2020-03-06 11:09 ` [PULL 16/33] docs/system: Convert security.texi to rST format Peter Maydell
2020-03-06 11:09 ` [PULL 17/33] docs/system: convert managed startup to rST Peter Maydell
2020-03-06 11:09 ` [PULL 18/33] docs/system: convert the documentation of deprecated features " Peter Maydell
2020-03-06 11:09 ` [PULL 19/33] docs/system: convert Texinfo documentation " Peter Maydell
2020-03-06 11:09 ` [PULL 20/33] hmp-commands.hx: Add rST documentation fragments Peter Maydell
2020-03-06 11:09 ` [PULL 21/33] hmp-commands-info.hx: " Peter Maydell
2020-03-06 11:09 ` [PULL 22/33] doc/scripts/hxtool.py: Strip trailing ':' from DEFHEADING/ARCHHEADING Peter Maydell
2020-03-06 11:09 ` [PULL 23/33] docs: Roll semihosting option information into qemu-options.hx Peter Maydell
2020-03-06 11:09 ` Peter Maydell [this message]
2020-03-06 11:09 ` [PULL 25/33] scripts/hxtool-conv: Archive script used in qemu-options.hx conversion Peter Maydell
2020-03-06 11:09 ` [PULL 26/33] qemu-options.hx: Add rST documentation fragments Peter Maydell
2020-03-06 11:09 ` [PULL 27/33] qemu-options.hx: Fix up the autogenerated rST Peter Maydell
2020-03-06 11:09 ` [PULL 28/33] docs: Split out sections for the manpage into .rst.inc files Peter Maydell
2020-03-06 11:09 ` [PULL 29/33] docs: Generate qemu.1 manpage with Sphinx Peter Maydell
2020-03-06 11:09 ` [PULL 30/33] ui/cocoa.m: Update documentation file and pathname Peter Maydell
2020-03-06 11:09 ` [PULL 31/33] docs: Stop building qemu-doc Peter Maydell
2020-03-06 11:09 ` [PULL 32/33] docs: Remove old texinfo sources Peter Maydell
2020-03-06 11:09 ` [PULL 33/33] *.hx: Remove all the STEXI/ETEXI blocks Peter Maydell
2020-03-06 11:37 ` [PULL 00/33] docs queue no-reply
2020-03-06 11:52 ` Peter Maydell
2020-03-06 11:55 ` no-reply
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=20200306110959.29461-25-peter.maydell@linaro.org \
--to=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).