qemu/docs/system
Peter Maydell e5910d42dd docs: Improve our gdbstub documentation
The documentation of our -s and -gdb options is quite old; in
particular it still claims that it will cause QEMU to stop and wait
for the gdb connection, when this has not been true for some time:
you also need to pass -S if you want to make QEMU not launch the
guest on startup.

Improve the documentation to mention this requirement in the
executable's --help output, the documentation of the -gdb option in
the manual, and in the "GDB usage" chapter.

Includes some minor tweaks to these paragraphs of documentation
since I was editing them anyway (such as dropping the description
of our gdb support as "primitive").

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
Message-id: 20200403094014.9589-1-peter.maydell@linaro.org
2020-04-14 13:15:40 +01:00
..
arm docs: add Orange Pi PC document 2020-03-12 16:27:33 +00:00
s390x Documentation: create/move s390x documentation 2020-03-23 12:36:27 +01:00
build-platforms.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
conf.py docs: Generate qemu.1 manpage with Sphinx 2020-03-06 11:06:55 +00:00
cpu-models-mips.rst.inc docs/system: Convert qemu-cpu-models.texi to rST 2020-03-06 10:05:12 +00:00
cpu-models-x86.rst.inc qemu-cpu-models.rst: Document -noTSX, mds-no, taa-no, and tsx-ctrl 2020-03-16 23:02:25 +01:00
deprecated.rst QAPI patches for 2020-03-17 2020-03-19 10:18:07 +00:00
device-url-syntax.rst.inc docs: Split out sections for the manpage into .rst.inc files 2020-03-06 11:06:55 +00:00
gdb.rst docs: Improve our gdbstub documentation 2020-04-14 13:15:40 +01:00
images.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
index.rst Documentation: create/move s390x documentation 2020-03-23 12:36:27 +01:00
invocation.rst docs: Split out sections for the manpage into .rst.inc files 2020-03-06 11:06:55 +00:00
ivshmem.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
keys.rst docs: Split out sections for the manpage into .rst.inc files 2020-03-06 11:06:55 +00:00
keys.rst.inc docs: Split out sections for the manpage into .rst.inc files 2020-03-06 11:06:55 +00:00
license.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
linuxboot.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
managed-startup.rst docs/system: convert managed startup to rST. 2020-03-06 10:05:12 +00:00
monitor.rst hmp-commands-info.hx: Add rST documentation fragments 2020-03-06 10:05:12 +00:00
mux-chardev.rst docs: Split out sections for the manpage into .rst.inc files 2020-03-06 11:06:55 +00:00
mux-chardev.rst.inc docs: Split out sections for the manpage into .rst.inc files 2020-03-06 11:06:55 +00:00
net.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
qemu-block-drivers.rst docs: Create defs.rst.inc as a place to define substitutions 2020-03-06 10:04:58 +00:00
qemu-block-drivers.rst.inc docs/system: put qemu-block-drivers body in an included file 2020-03-06 10:04:58 +00:00
qemu-cpu-models.rst docs/system: Convert qemu-cpu-models.texi to rST 2020-03-06 10:05:12 +00:00
qemu-manpage.rst docs: Generate qemu.1 manpage with Sphinx 2020-03-06 11:06:55 +00:00
quickstart.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
security.rst docs/system: Convert security.texi to rST format 2020-03-06 10:05:12 +00:00
target-arm.rst docs: add Orange Pi PC document 2020-03-12 16:27:33 +00:00
target-i386-desc.rst.inc docs: Split out sections for the manpage into .rst.inc files 2020-03-06 11:06:55 +00:00
target-i386.rst docs: Split out sections for the manpage into .rst.inc files 2020-03-06 11:06:55 +00:00
target-m68k.rst docs: Roll semihosting option information into qemu-options.hx 2020-03-06 10:05:12 +00:00
target-mips.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
target-ppc.rst docs: Roll -prom-env and -g target-specific info into qemu-options.hx 2020-03-06 10:05:18 +00:00
target-s390x.rst Documentation: create/move s390x documentation 2020-03-23 12:36:27 +01:00
target-sparc64.rst docs: Roll -prom-env and -g target-specific info into qemu-options.hx 2020-03-06 10:05:18 +00:00
target-sparc.rst docs: Roll -prom-env and -g target-specific info into qemu-options.hx 2020-03-06 10:05:18 +00:00
target-xtensa.rst docs: Roll semihosting option information into qemu-options.hx 2020-03-06 10:05:12 +00:00
targets.rst Documentation: create/move s390x documentation 2020-03-23 12:36:27 +01:00
tls.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
usb.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
vnc-security.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00