From: Thomas Huth <huth@tuxfamily.org>
To: qemu-devel@nongnu.org, "Michael Rolnik" <mrolnik@gmail.com>,
"Philippe Mathieu-Daudé" <f4bug@amsat.org>
Cc: qemu-trivial@nongnu.org, Sarah Harris <S.E.Harris@kent.ac.uk>
Subject: [PATCH] docs/system/target-avr: Improve the AVR docs and add to MAINTAINERS
Date: Wed, 12 Aug 2020 17:53:04 +0200 [thread overview]
Message-ID: <20200812155304.18016-1-huth@tuxfamily.org> (raw)
The examples look nicer when using "::" code blocks.
Also mention that "-d in_asm" only outputs instructions that have not
been translated by the JIT layer yet.
And while we're at it, also add the AVR doc file to the MAINTAINERS file.
Signed-off-by: Thomas Huth <huth@tuxfamily.org>
---
MAINTAINERS | 1 +
docs/system/target-avr.rst | 47 +++++++++++++++++++++++---------------
2 files changed, 30 insertions(+), 18 deletions(-)
diff --git a/MAINTAINERS b/MAINTAINERS
index 0886eb3d2b..5b21962bc6 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -171,6 +171,7 @@ AVR TCG CPUs
M: Michael Rolnik <mrolnik@gmail.com>
R: Sarah Harris <S.E.Harris@kent.ac.uk>
S: Maintained
+F: docs/system/target-avr.rst
F: gdb-xml/avr-cpu.xml
F: target/avr/
F: tests/acceptance/machine_avr6.py
diff --git a/docs/system/target-avr.rst b/docs/system/target-avr.rst
index dc99afc895..1410031f5e 100644
--- a/docs/system/target-avr.rst
+++ b/docs/system/target-avr.rst
@@ -17,21 +17,32 @@ https://github.com/seharris/qemu-avr-tests/blob/master/free-rtos/Demo/AVR_ATMega
Following are examples of possible usages, assuming demo.elf is compiled for
AVR cpu
- - Continuous non interrupted execution:
- ``qemu-system-avr -machine mega2560 -bios demo.elf``
-
- - Continuous non interrupted execution with serial output into telnet window:
- ``qemu-system-avr -machine mega2560 -bios demo.elf -serial
- tcp::5678,server,nowait -nographic``
- and then in another shell
- ``telnet localhost 5678``
-
- - Debugging wit GDB debugger:
- ``qemu-system-avr -machine mega2560 -bios demo.elf -s -S``
- and then in another shell
- ``avr-gdb demo.elf``
- and then within GDB shell
- ``target remote :1234``
-
- - Print out executed instructions:
- ``qemu-system-avr -machine mega2560 -bios demo.elf -d in_asm``
+- Continuous non interrupted execution::
+
+ qemu-system-avr -machine mega2560 -bios demo.elf
+
+- Continuous non interrupted execution with serial output into telnet window::
+
+ qemu-system-avr -M mega2560 -bios demo.elf -nographic \
+ -serial tcp::5678,server,nowait
+
+ and then in another shell::
+
+ telnet localhost 5678
+
+- Debugging wit GDB debugger::
+
+ qemu-system-avr -machine mega2560 -bios demo.elf -s -S
+
+ and then in another shell::
+
+ avr-gdb demo.elf
+
+ and then within GDB shell::
+
+ target remote :1234
+
+- Print out executed instructions (that have not been translated by the JIT
+ compiler yet)::
+
+ qemu-system-avr -machine mega2560 -bios demo.elf -d in_asm
--
2.26.2
next reply other threads:[~2020-08-12 15:53 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-08-12 15:53 Thomas Huth [this message]
2020-08-13 15:07 ` [PATCH] docs/system/target-avr: Improve the AVR docs and add to MAINTAINERS no-reply
2020-08-13 16:50 ` Richard Henderson
2020-08-13 19:44 ` Michael Rolnik
2020-09-01 9:15 ` Laurent Vivier
2020-09-01 10:05 ` Thomas Huth
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=20200812155304.18016-1-huth@tuxfamily.org \
--to=huth@tuxfamily.org \
--cc=S.E.Harris@kent.ac.uk \
--cc=f4bug@amsat.org \
--cc=mrolnik@gmail.com \
--cc=qemu-devel@nongnu.org \
--cc=qemu-trivial@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).