Re: [PATCH] docs/system/target-avr: Improve the AVR docs and add to MAINTAINERS

[Thomas Huth]

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