[v2] doc: fix Arm socs list
Checks
Commit Message
Keep the list of socs in a single place and include it so that the
documentation won't get outdated.
Fixes: 8f5ea6a464ac ("config/arm: fix implementer and its SoCs")
Fixes: 1b4c86a721c9 ("config/arm: add Marvell CN10K")
Fixes: 7cf32a22b240 ("config/arm: add Hisilicon kunpeng")
Signed-off-by: David Marchand <david.marchand@redhat.com>
Reviewed-by: Jerin Jacob <jerinj@marvell.com>
Reviewed-by: Ruifeng Wang <ruifeng.wang@arm.com>
---
Changes since v1:
- made use of an anonymous string literal instead of comments,
- dropped the #guide_doc tag,
---
config/arm/meson.build | 21 +++++++++++++++++++
.../linux_gsg/cross_build_dpdk_for_arm64.rst | 18 +++++-----------
2 files changed, 26 insertions(+), 13 deletions(-)
Comments
On Tue, May 4, 2021 at 2:43 PM David Marchand <david.marchand@redhat.com> wrote:
>
> Keep the list of socs in a single place and include it so that the
> documentation won't get outdated.
>
> Fixes: 8f5ea6a464ac ("config/arm: fix implementer and its SoCs")
> Fixes: 1b4c86a721c9 ("config/arm: add Marvell CN10K")
> Fixes: 7cf32a22b240 ("config/arm: add Hisilicon kunpeng")
>
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> Reviewed-by: Jerin Jacob <jerinj@marvell.com>
> Reviewed-by: Ruifeng Wang <ruifeng.wang@arm.com>
There is currently no consensus on which tag to use for inclusion in
the documentation [1].
I'll go with an explicit comment.
Applied.
1: http://inbox.dpdk.org/dev/d679d898-0768-7a4e-20de-c60044223c95@intel.com/T/#m27ef8effe96a843710a1d48817e83c76081d2d30
@@ -321,6 +321,27 @@ soc_thunderxt88 = {
'part_number': '0xa1'
}
+'''
+Start of socs list
+generic: Generic un-optimized build for all aarch64 machines.
+armada: Marvell ARMADA
+bluefield: NVIDIA BlueField
+cn10k: Marvell OCTEON 10
+dpaa: NXP DPAA
+emag: Ampere eMAG
+graviton2: AWS Graviton2
+kunpeng920: HiSilicon Kunpeng 920
+kunpeng930: HiSilicon Kunpeng 930
+n1sdp: Arm Neoverse N1SDP
+n2: Arm Neoverse N2
+octeontx2: Marvell OCTEON TX2
+stingray: Broadcom Stingray
+thunderx2: Marvell ThunderX2 T99
+thunderxt88: Marvell ThunderX T88
+End of socs list
+'''
+# The string above is included in the documentation, keep it in sync with the
+# socs list below.
socs = {
'generic': soc_generic,
'armada': soc_armada,
@@ -197,19 +197,11 @@ option::
meson soc_build -Dplatform=<target_soc>
-Substitute <target_soc> with one of the supported SoCs::
-
- generic: Generic un-optimized build for all aarch64 machines.
- armada: Marvell ARMADA
- bluefield: NVIDIA BlueField
- dpaa: NXP DPAA
- emag: Ampere eMAG
- graviton2: AWS Graviton2
- n1sdp: Arm Neoverse N1SDP
- octeontx2: Marvell OCTEON TX2
- stingray: Broadcom Stingray
- thunderx2: Marvell ThunderX2 T99
- thunderxt88: Marvell ThunderX T88
+Substitute <target_soc> with one of the supported SoCs
+
+.. literalinclude:: ../../../config/arm/meson.build
+ :start-after: Start of socs list
+ :end-before: End of socs list
These SoCs are also used in cross files, e.g.::