diff mbox series

docs/system/target-avr: Improve the AVR docs and add to MAINTAINERS

Message ID 20200812155304.18016-1-huth@tuxfamily.org
State New
Headers show
Series docs/system/target-avr: Improve the AVR docs and add to MAINTAINERS | expand

Commit Message

Thomas Huth Aug. 12, 2020, 3:53 p.m. UTC
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(-)

Comments

no-reply@patchew.org Aug. 13, 2020, 3:07 p.m. UTC | #1
Patchew URL: https://patchew.org/QEMU/20200812155304.18016-1-huth@tuxfamily.org/



Hi,

This series seems to have some coding style problems. See output below for
more information:

Type: series
Message-id: 20200812155304.18016-1-huth@tuxfamily.org
Subject: [PATCH] docs/system/target-avr: Improve the AVR docs and add to MAINTAINERS

=== TEST SCRIPT BEGIN ===
#!/bin/bash
git rev-parse base > /dev/null || exit 0
git config --local diff.renamelimit 0
git config --local diff.renames True
git config --local diff.algorithm histogram
./scripts/checkpatch.pl --mailback base..
=== TEST SCRIPT END ===

Switched to a new branch 'test'
22fbf8b docs/system/target-avr: Improve the AVR docs and add to MAINTAINERS

=== OUTPUT BEGIN ===
ERROR: trailing whitespace
#57: FILE: docs/system/target-avr.rst:27:
+                   -serial tcp::5678,server,nowait $

total: 1 errors, 0 warnings, 54 lines checked

Commit 22fbf8be9919 (docs/system/target-avr: Improve the AVR docs and add to MAINTAINERS) has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
=== OUTPUT END ===

Test command exited with code: 1


The full log is available at
http://patchew.org/logs/20200812155304.18016-1-huth@tuxfamily.org/testing.checkpatch/?type=message.
---
Email generated automatically by Patchew [https://patchew.org/].
Please send your feedback to patchew-devel@redhat.com
Richard Henderson Aug. 13, 2020, 4:50 p.m. UTC | #2
On 8/12/20 8:53 AM, Thomas Huth wrote:
> 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(-)

Reviewed-by: Richard Henderson <richard.henderson@linaro.org>

r~
Michael Rolnik Aug. 13, 2020, 7:44 p.m. UTC | #3
Reviewed-by: Michael Rolnik <mrolnik@gmail.com>

On Thu, Aug 13, 2020 at 7:50 PM Richard Henderson <
richard.henderson@linaro.org> wrote:

> On 8/12/20 8:53 AM, Thomas Huth wrote:
> > 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(-)
>
> Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
>
> r~
>
Laurent Vivier Sept. 1, 2020, 9:15 a.m. UTC | #4
Le 12/08/2020 à 17:53, Thomas Huth a écrit :
> 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
> 

Applied to my trivial-patches branch.
(I have removed the trailing whitespace)

Thanks,
Laurent
Thomas Huth Sept. 1, 2020, 10:05 a.m. UTC | #5
On 01/09/2020 11.15, Laurent Vivier wrote:
> Le 12/08/2020 à 17:53, Thomas Huth a écrit :
>> 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
>>
> 
> Applied to my trivial-patches branch.
> (I have removed the trailing whitespace)

Great, thanks! I saw the mail from patchew, but never got around to send
a v2 with the space removed...

 Thomas
diff mbox series

Patch

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