Re: [PATCH 0/5] docs/system: Document some arm board models

["Philippe Mathieu-Daudé" <philmd@redhat.com>]

Hi Peter,

+Markus

On 5/14/20 3:28 PM, Peter Maydell wrote:
> Ping for review?

For the series:
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>

However I'd rather see the board documentation in the source code, and 
extract it when building. It'd be harder to miss updating the 
documentation when modifying the code.

Another way (rather than using external program to extract from source 
code) can be to add a method/field to MachineClass, and once a build is 
finished, we could run 'qemu-system-arch -M gendoc' which go thru all 
machines and display the documentation properly formatted.

> 
> thanks
> -- PMM
> 
> On Thu, 7 May 2020 at 16:18, Peter Maydell <peter.maydell@linaro.org> wrote:
>>
>> This patchset adds (minimal) documentation of these Arm board models:
>>
>> vexpress-a15         ARM Versatile Express for Cortex-A15
>> vexpress-a9          ARM Versatile Express for Cortex-A9
>> mps2-an385           ARM MPS2 with AN385 FPGA image for Cortex-M35
>> mps2-an505           ARM MPS2 with AN505 FPGA image for Cortex-M33
>> mps2-an511           ARM MPS2 with AN511 DesignStart FPGA image for Cortex-M3
>> mps2-an521           ARM MPS2 with AN521 FPGA image for dual Cortex-M33
>> musca-a              ARM Musca-A board (dual Cortex-M33)
>> musca-b1             ARM Musca-B1 board (dual Cortex-M33)
>>
>> to the system emulator manual.
>>
>> Patches 1 and 2 are minor tidyup of the board table-of-contents
>> before we start adding new entries with patches 3-5.
>>
>> I'm aiming more for "at least note that the boards exist" than
>> "fully comprehensive" documentation here -- there are still another
>> 37 Arm board models with no documentation at all...
>>
>> thanks
>> -- PMM
>>
>> Peter Maydell (5):
>>    docs/system: Add 'Arm' to the Integrator/CP document title
>>    docs/system: Sort Arm board index into alphabetical order
>>    docs/system: Document Arm Versatile Express boards
>>    docs/system: Document the various MPS2 models
>>    docs/system: Document Musca boards
>>
>>   docs/system/arm/integratorcp.rst |  4 +--
>>   docs/system/arm/mps2.rst         | 29 +++++++++++++++
>>   docs/system/arm/musca.rst        | 31 +++++++++++++++++
>>   docs/system/arm/vexpress.rst     | 60 ++++++++++++++++++++++++++++++++
>>   docs/system/target-arm.rst       | 15 ++++----
>>   MAINTAINERS                      |  3 ++
>>   6 files changed, 134 insertions(+), 8 deletions(-)
>>   create mode 100644 docs/system/arm/mps2.rst
>>   create mode 100644 docs/system/arm/musca.rst
>>   create mode 100644 docs/system/arm/vexpress.rst
>>
>> --
>> 2.20.1
>>
>