diff mbox series

[43/44] docs/system/arm/mps2.rst: Document the new mps3-an547 board

Message ID 20210219144617.4782-44-peter.maydell@linaro.org (mailing list archive)
State New, archived
Headers show
Series hw/arm: New board model mps3-an547 | expand

Commit Message

Peter Maydell Feb. 19, 2021, 2:46 p.m. UTC
Add brief documentation of the new mps3-an547 board.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
 docs/system/arm/mps2.rst | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

Comments

Philippe Mathieu-Daudé March 4, 2021, 8:28 p.m. UTC | #1
On 2/19/21 3:46 PM, Peter Maydell wrote:
> Add brief documentation of the new mps3-an547 board.
> 
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
>  docs/system/arm/mps2.rst | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)

Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
Richard Henderson March 5, 2021, 1:28 a.m. UTC | #2
On 2/19/21 6:46 AM, Peter Maydell wrote:
> @@ -1,5 +1,5 @@
> -Arm MPS2 and MPS3 boards (``mps2-an385``, ``mps2-an386``, ``mps2-an500``, ``mps2-an505``, ``mps2-an511``, ``mps2-an521``, ``mps3-an524``)
> -=========================================================================================================================================
> +Arm MPS2 and MPS3 boards (``mps2-an385``, ``mps2-an386``, ``mps2-an500``, ``mps2-an505``, ``mps2-an511``, ``mps2-an521``, ``mps3-an524``, ``mps3-an547``)'
I think you should drop the list here, as it has gotten *way* too long.

> @@ -27,6 +27,8 @@ QEMU models the following FPGA images:
>     Dual Cortex-M33 as documented in Arm Application Note AN521
>   ``mps3-an524``
>     Dual Cortex-M33 on an MPS3, as documented in Arm Application Note AN524
> +``mps3-an547``
> +  Cortex-M55 on an MPS3, as documented in Arm Application Note AN547

The list is down here, anyway.


r~
Peter Maydell March 5, 2021, 10:22 a.m. UTC | #3
On Fri, 5 Mar 2021 at 01:28, Richard Henderson
<richard.henderson@linaro.org> wrote:
>
> On 2/19/21 6:46 AM, Peter Maydell wrote:
> > @@ -1,5 +1,5 @@
> > -Arm MPS2 and MPS3 boards (``mps2-an385``, ``mps2-an386``, ``mps2-an500``, ``mps2-an505``, ``mps2-an511``, ``mps2-an521``, ``mps3-an524``)
> > -=========================================================================================================================================
> > +Arm MPS2 and MPS3 boards (``mps2-an385``, ``mps2-an386``, ``mps2-an500``, ``mps2-an505``, ``mps2-an511``, ``mps2-an521``, ``mps3-an524``, ``mps3-an547``)'
> I think you should drop the list here, as it has gotten *way* too long.
>
> > @@ -27,6 +27,8 @@ QEMU models the following FPGA images:
> >     Dual Cortex-M33 as documented in Arm Application Note AN521
> >   ``mps3-an524``
> >     Dual Cortex-M33 on an MPS3, as documented in Arm Application Note AN524
> > +``mps3-an547``
> > +  Cortex-M55 on an MPS3, as documented in Arm Application Note AN547
>
> The list is down here, anyway.

The title is what generates the text for the table of contents in the
next page up:

https://qemu-project.gitlab.io/qemu/system/target-arm.html#board-specific-documentation

I like having every board model listed explicitly in that ToC. (Though we
have broken this rule for the Aspeed boards with "*-bmc"...)

-- PMM
Peter Maydell March 8, 2021, 5:35 p.m. UTC | #4
On Fri, 5 Mar 2021 at 10:22, Peter Maydell <peter.maydell@linaro.org> wrote:
>
> On Fri, 5 Mar 2021 at 01:28, Richard Henderson
> <richard.henderson@linaro.org> wrote:
> >
> > On 2/19/21 6:46 AM, Peter Maydell wrote:
> > > @@ -1,5 +1,5 @@
> > > -Arm MPS2 and MPS3 boards (``mps2-an385``, ``mps2-an386``, ``mps2-an500``, ``mps2-an505``, ``mps2-an511``, ``mps2-an521``, ``mps3-an524``)
> > > -=========================================================================================================================================
> > > +Arm MPS2 and MPS3 boards (``mps2-an385``, ``mps2-an386``, ``mps2-an500``, ``mps2-an505``, ``mps2-an511``, ``mps2-an521``, ``mps3-an524``, ``mps3-an547``)'
> > I think you should drop the list here, as it has gotten *way* too long.
> >
> > > @@ -27,6 +27,8 @@ QEMU models the following FPGA images:
> > >     Dual Cortex-M33 as documented in Arm Application Note AN521
> > >   ``mps3-an524``
> > >     Dual Cortex-M33 on an MPS3, as documented in Arm Application Note AN524
> > > +``mps3-an547``
> > > +  Cortex-M55 on an MPS3, as documented in Arm Application Note AN547
> >
> > The list is down here, anyway.
>
> The title is what generates the text for the table of contents in the
> next page up:
>
> https://qemu-project.gitlab.io/qemu/system/target-arm.html#board-specific-documentation
>
> I like having every board model listed explicitly in that ToC. (Though we
> have broken this rule for the Aspeed boards with "*-bmc"...)

I put this patch into the pullreq as-is, because the series is otherwise
ready to go and this was a minor thing; happy to send a followup patch
tweaking the title text if we conclude that we want to do that.

thanks
-- PMM
diff mbox series

Patch

diff --git a/docs/system/arm/mps2.rst b/docs/system/arm/mps2.rst
index 601ccea15cb..f83b1517871 100644
--- a/docs/system/arm/mps2.rst
+++ b/docs/system/arm/mps2.rst
@@ -1,5 +1,5 @@ 
-Arm MPS2 and MPS3 boards (``mps2-an385``, ``mps2-an386``, ``mps2-an500``, ``mps2-an505``, ``mps2-an511``, ``mps2-an521``, ``mps3-an524``)
-=========================================================================================================================================
+Arm MPS2 and MPS3 boards (``mps2-an385``, ``mps2-an386``, ``mps2-an500``, ``mps2-an505``, ``mps2-an511``, ``mps2-an521``, ``mps3-an524``, ``mps3-an547``)
+=========================================================================================================================================================
 
 These board models all use Arm M-profile CPUs.
 
@@ -27,6 +27,8 @@  QEMU models the following FPGA images:
   Dual Cortex-M33 as documented in Arm Application Note AN521
 ``mps3-an524``
   Dual Cortex-M33 on an MPS3, as documented in Arm Application Note AN524
+``mps3-an547``
+  Cortex-M55 on an MPS3, as documented in Arm Application Note AN547
 
 Differences between QEMU and real hardware: