doc: fix Arm socs list
PATCH 1/1 doc: fix Arm socs list
Keep the list of socs in a single place and include it so that the documentation won't get outdated.
--- config/arm/meson.build | 19 +++++++++++++++++++ .../linux_gsg/cross_build_dpdk_for_arm64.rst | 18 +++++------------- 2 files changed, 24 insertions(+), 13 deletions(-)
config/arm/meson.build +19 -0
@@ -321,6 +321,25 @@ soc_thunderxt88 = { 'part_number': '0xa1' } +# Keep this part in sync with the socs list below: +# +# #guide_doc 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 +# #guide_doc End of socs list socs = { 'generic': soc_generic, 'armada': soc_armada,
doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst +5 -13
@@ -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: #guide_doc Start of socs list + :end-before: #guide_doc End of socs list These SoCs are also used in cross files, e.g.::
Signature · 1 line
2.23.0
Quoted 8 lines · David Marchand
Keep the list of socs in a single place and include it so that the documentation won't get outdated.
Fixes 1b4c86a721c9 ("config/arm: add Marvell CN10K")Fixes 7cf32a22b240 ("config/arm: add Hisilicon kunpeng")Signed-off-by David Marchand <[email protected]>
+ @Juraj Linkeš
Could you enroll as maintainer for config/arm/meson.build file as most of the change for this file done by you in the rework.
Quoted 67 lines
--- config/arm/meson.build | 19 +++++++++++++++++++ .../linux_gsg/cross_build_dpdk_for_arm64.rst | 18 +++++------------- 2 files changed, 24 insertions(+), 13 deletions(-)config/arm/meson.build +19
-0@@ -321,6 +321,25 @@ soc_thunderxt88 = { 'part_number': '0xa1' } +# Keep this part in sync with the socs list below: +# +# #guide_doc 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 +# #guide_doc End of socs list socs = { 'generic': soc_generic, 'armada': soc_armada,doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst +5
-14@@ -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: #guide_doc Start of socs list + :end-before: #guide_doc End of socs list These SoCs are also used in cross files, e.g.:: --2.23.0
Quoted 21 lines
-----Original Message-----
From: Jerin Jacob <[email protected]>
Sent: Thursday, April 29, 2021 11:23 AM
To: David Marchand <[email protected]>; Juraj Linkeš <[email protected]>
Cc: dpdk-dev <[email protected]>; Thomas Monjalon <[email protected]>; Jerin Jacob <[email protected]>; Ruifeng Wang <[email protected]>; Jan Viktorin <[email protected]>; Bruce Richardson <[email protected]>; Pavan Nikhilesh <[email protected]>; Nithin Dabilpuram <[email protected]>; Lijun Ou <[email protected]>; Chengchang Tang <[email protected]>
Subject: Re: [dpdk-dev] [PATCH] doc: fix Arm socs listQuoted 4 lines · David Marchand
Keep the list of socs in a single place and include it so that the documentation won't get outdated.
Quoted 8 lines
Quoted 4 lines
Fixes 1b4c86a721c9 ("config/arm: add Marvell CN10K")Fixes 7cf32a22b240 ("config/arm: add Hisilicon kunpeng")Signed-off-by David Marchand <[email protected]>Reviewed-by Jerin Jacob <[email protected]>+ @Juraj Linkeš
Thanks for adding me.
Quoted 3 lines
Could you enroll as maintainer for config/arm/meson.build file as most of the change for this file done by you in the rework.
Gladly, how do I do that? I didn't find anything about this in docs. Should I just submit a patch where I add myself to the MAINTAINERS file?
Quoted 69 lines
Quoted 69 lines
--- config/arm/meson.build | 19 +++++++++++++++++++ .../linux_gsg/cross_build_dpdk_for_arm64.rst | 18 +++++------------- 2 files changed, 24 insertions(+), 13 deletions(-)config/arm/meson.build index renamed from config/arm/meson.build +0
-0
22cd81319c..fbe942e5ec100644config/arm/meson.build +19
-0@@ -321,6 +321,25 @@ soc_thunderxt88 = { 'part_number': '0xa1' } +# Keep this part in sync with the socs list below: +# +# #guide_doc 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 +# #guide_doc End of socs list socs = { 'generic': soc_generic, 'armada': soc_armada,doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst +5
-14@@ -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: #guide_doc Start of socs list + :end-before: #guide_doc End of socs list These SoCs are also used in cross files, e.g.:: --2.23.0
29/04/2021 11:54, Juraj Linkeš:
Quoted 16 lines
From: Jerin Jacob <[email protected]>
Quoted 6 lines
Quoted 4 lines · David Marchand
Keep the list of socs in a single place and include it so that the documentation won't get outdated.
Quoted 8 lines
Quoted 4 lines
Fixes 1b4c86a721c9 ("config/arm: add Marvell CN10K")Fixes 7cf32a22b240 ("config/arm: add Hisilicon kunpeng")Signed-off-by David Marchand <[email protected]>Reviewed-by Jerin Jacob <[email protected]>+ @Juraj Linkeš
Quoted 7 lines
Thanks for adding me.
Quoted 3 lines
Could you enroll as maintainer for config/arm/meson.build file as most of the change for this file done by you in the rework.
Gladly, how do I do that? I didn't find anything about this in docs. Should I just submit a patch where I add myself to the
MAINTAINERSfile?
In general we avoid such fine granularity in MAINTAINERS. This file is maintained as part of the ARM v8 area.
Quoted 14 lines
-----Original Message-----
From: dev <[email protected]> On Behalf Of David Marchand
Sent: Thursday, April 29, 2021 9:08 AM
To: [email protected]
Cc: [email protected]; Jerin Jacob <[email protected]>; Ruifeng Wang <[email protected]>; Jan Viktorin <[email protected]>; Bruce Richardson <[email protected]>; Pavan Nikhilesh <[email protected]>; Nithin Dabilpuram <[email protected]>; Lijun Ou <[email protected]>; Chengchang Tang <[email protected]>
Subject: [dpdk-dev] [PATCH] doc: fix Arm socs list
Quoted 6 lines
Keep the list of socs in a single place and include it so that the documentation won't get outdated.
Fixes 1b4c86a721c9 ("config/arm: add Marvell CN10K")Fixes 7cf32a22b240 ("config/arm: add Hisilicon kunpeng")
I still think this also fixes 8f5ea6a464ac ("config/arm: fix implementer and its SoCs"), as that patch missed the n2 soc in docs.
Quoted 69 lines
Signed-off-by David Marchand <[email protected]>--- config/arm/meson.build | 19 +++++++++++++++++++ .../linux_gsg/cross_build_dpdk_for_arm64.rst | 18 +++++------------- 2 files changed, 24 insertions(+), 13 deletions(-)config/arm/meson.build index renamed from config/arm/meson.build +0
-0
22cd81319c..fbe942e5ec100644config/arm/meson.build +19
-0@@ -321,6 +321,25 @@ soc_thunderxt88 = { 'part_number': '0xa1' } +# Keep this part in sync with the socs list below: +# +# #guide_doc 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 +# #guide_doc End of socs list socs = { 'generic': soc_generic, 'armada': soc_armada,doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst +5
-14@@ -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: #guide_doc Start of socs list + :end-before: #guide_doc End of socs list These SoCs are also used in cross files, e.g.:: --2.23.0
Quoted 12 lines · Juraj Linkeš
Quoted 12 lines
-----Original Message-----
From: dev <[email protected]> On Behalf Of David Marchand
Sent: Thursday, April 29, 2021 9:08 AM
To: [email protected]
Cc: [email protected]; Jerin Jacob <[email protected]>; Ruifeng Wang <[email protected]>; Jan Viktorin <[email protected]>; Bruce Richardson <[email protected]>; Pavan Nikhilesh <[email protected]>; Nithin Dabilpuram <[email protected]>; Lijun Ou <[email protected]>; Chengchang Tang <[email protected]>
Subject: [dpdk-dev] [PATCH] doc: fix Arm socs list
Quoted 8 lines
Quoted 6 lines
Keep the list of socs in a single place and include it so that the documentation won't get outdated.
Fixes 1b4c86a721c9 ("config/arm: add Marvell CN10K")Fixes 7cf32a22b240 ("config/arm: add Hisilicon kunpeng")I still think this also fixes
8f5ea6a464ac("config/arm: fix implementer and its SoCs"), as that patch missed the n2 soc in docs.
Thanks Juraj.
I will add it in v2 (which I'll send once we conclude on the #guide_doc tag format in the other thread from Conor).
Signature · 1 line
David Marchand
Quoted 85 lines
-----Original Message-----
From: David Marchand <[email protected]>
Sent: Thursday, April 29, 2021 3:08 PM
To: [email protected]
Cc: [email protected]; [email protected]; Ruifeng Wang <[email protected]>; Jan Viktorin <[email protected]>; Bruce Richardson <[email protected]>; Pavan Nikhilesh <[email protected]>; Nithin Dabilpuram <[email protected]>; Lijun Ou <[email protected]>; Chengchang Tang <[email protected]>
Subject: [PATCH] doc: fix Arm socs listKeep the list of socs in a single place and include it so that the documentation won't get outdated.
Fixes 1b4c86a721c9 ("config/arm: add Marvell CN10K")Fixes 7cf32a22b240 ("config/arm: add Hisilicon kunpeng")Signed-off-by David Marchand <[email protected]>--- config/arm/meson.build | 19 +++++++++++++++++++ .../linux_gsg/cross_build_dpdk_for_arm64.rst | 18 +++++------------- 2 files changed, 24 insertions(+), 13 deletions(-)config/arm/meson.build index renamed from config/arm/meson.build +0
-0
22cd81319c..fbe942e5ec100644config/arm/meson.build +19
-0@@ -321,6 +321,25 @@ soc_thunderxt88 = { 'part_number': '0xa1' } +# Keep this part in sync with the socs list below: +# +# #guide_doc 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 +# #guide_doc End of socs list socs = { 'generic': soc_generic, 'armada': soc_armada,doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst +5
-14@@ -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: #guide_doc Start of socs list + :end-before: #guide_doc End of socs list These SoCs are also used in cross files, e.g.:: --
Quoted 1 line
2.23.0
Thanks for the change. It is great help on doc maintenance.
PATCH v2 1/1 doc: fix Arm socs list
In reply to David MarchandKeep the list of socs in a single place and include it so that the documentation won't get outdated.
---
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(-)
config/arm/meson.build +21 -0
@@ -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,
doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst +5 -13
@@ -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.::
Signature · 1 line
2.23.0
David Marchand
AppliedQuoted 11 lines · David Marchand
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 <[email protected]>Reviewed-by Jerin Jacob <[email protected]>Reviewed-by Ruifeng Wang <[email protected]>
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/[email protected]/T/#m27ef8effe96a843710a1d48817e83c76081d2d30
Signature · 1 line
David Marchand