Checks
Commit Message
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 <david.marchand@redhat.com>
---
config/arm/meson.build | 19 +++++++++++++++++++
.../linux_gsg/cross_build_dpdk_for_arm64.rst | 18 +++++-------------
2 files changed, 24 insertions(+), 13 deletions(-)
Comments
On Thu, Apr 29, 2021 at 12:38 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: 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>
+ @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.
> ---
> config/arm/meson.build | 19 +++++++++++++++++++
> .../linux_gsg/cross_build_dpdk_for_arm64.rst | 18 +++++-------------
> 2 files changed, 24 insertions(+), 13 deletions(-)
>
> diff --git a/config/arm/meson.build b/config/arm/meson.build
> index 22cd81319c..fbe942e5ec 100644
> --- a/config/arm/meson.build
> +++ b/config/arm/meson.build
> @@ -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,
> diff --git a/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst b/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst
> index 3857cdefe9..958bc81784 100644
> --- a/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst
> +++ b/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst
> @@ -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
>
> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of David Marchand
> Sent: Thursday, April 29, 2021 9:08 AM
> To: dev@dpdk.org
> Cc: thomas@monjalon.net; Jerin Jacob <jerinj@marvell.com>; Ruifeng Wang
> <ruifeng.wang@arm.com>; Jan Viktorin <viktorin@rehivetech.com>; Bruce
> Richardson <bruce.richardson@intel.com>; Pavan Nikhilesh
> <pbhagavatula@marvell.com>; Nithin Dabilpuram
> <ndabilpuram@marvell.com>; Lijun Ou <oulijun@huawei.com>; Chengchang
> Tang <tangchengchang@huawei.com>
> Subject: [dpdk-dev] [PATCH] 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.
>
> 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.
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
> config/arm/meson.build | 19 +++++++++++++++++++
> .../linux_gsg/cross_build_dpdk_for_arm64.rst | 18 +++++-------------
> 2 files changed, 24 insertions(+), 13 deletions(-)
>
> diff --git a/config/arm/meson.build b/config/arm/meson.build index
> 22cd81319c..fbe942e5ec 100644
> --- a/config/arm/meson.build
> +++ b/config/arm/meson.build
> @@ -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,
> diff --git a/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst
> b/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst
> index 3857cdefe9..958bc81784 100644
> --- a/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst
> +++ b/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst
> @@ -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
>
> -----Original Message-----
> From: Jerin Jacob <jerinjacobk@gmail.com>
> Sent: Thursday, April 29, 2021 11:23 AM
> To: David Marchand <david.marchand@redhat.com>; Juraj Linkeš
> <juraj.linkes@pantheon.tech>
> Cc: dpdk-dev <dev@dpdk.org>; Thomas Monjalon <thomas@monjalon.net>;
> Jerin Jacob <jerinj@marvell.com>; Ruifeng Wang <ruifeng.wang@arm.com>;
> Jan Viktorin <viktorin@rehivetech.com>; Bruce Richardson
> <bruce.richardson@intel.com>; Pavan Nikhilesh <pbhagavatula@marvell.com>;
> Nithin Dabilpuram <ndabilpuram@marvell.com>; Lijun Ou
> <oulijun@huawei.com>; Chengchang Tang <tangchengchang@huawei.com>
> Subject: Re: [dpdk-dev] [PATCH] doc: fix Arm socs list
>
> On Thu, Apr 29, 2021 at 12:38 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: 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>
>
> + @Juraj Linkeš
Thanks for adding me.
>
> 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?
>
> > ---
> > config/arm/meson.build | 19 +++++++++++++++++++
> > .../linux_gsg/cross_build_dpdk_for_arm64.rst | 18 +++++-------------
> > 2 files changed, 24 insertions(+), 13 deletions(-)
> >
> > diff --git a/config/arm/meson.build b/config/arm/meson.build index
> > 22cd81319c..fbe942e5ec 100644
> > --- a/config/arm/meson.build
> > +++ b/config/arm/meson.build
> > @@ -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,
> > diff --git a/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst
> > b/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst
> > index 3857cdefe9..958bc81784 100644
> > --- a/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst
> > +++ b/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst
> > @@ -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
> >
On Thu, Apr 29, 2021 at 11:53 AM Juraj Linkeš
<juraj.linkes@pantheon.tech> wrote:
> > -----Original Message-----
> > From: dev <dev-bounces@dpdk.org> On Behalf Of David Marchand
> > Sent: Thursday, April 29, 2021 9:08 AM
> > To: dev@dpdk.org
> > Cc: thomas@monjalon.net; Jerin Jacob <jerinj@marvell.com>; Ruifeng Wang
> > <ruifeng.wang@arm.com>; Jan Viktorin <viktorin@rehivetech.com>; Bruce
> > Richardson <bruce.richardson@intel.com>; Pavan Nikhilesh
> > <pbhagavatula@marvell.com>; Nithin Dabilpuram
> > <ndabilpuram@marvell.com>; Lijun Ou <oulijun@huawei.com>; Chengchang
> > Tang <tangchengchang@huawei.com>
> > Subject: [dpdk-dev] [PATCH] 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.
> >
> > 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).
29/04/2021 11:54, Juraj Linkeš:
> From: Jerin Jacob <jerinjacobk@gmail.com>
> > On Thu, Apr 29, 2021 at 12:38 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: 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>
> >
> > + @Juraj Linkeš
>
> Thanks for adding me.
>
> >
> > 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?
In general we avoid such fine granularity in MAINTAINERS.
This file is maintained as part of the ARM v8 area.
> -----Original Message-----
> From: David Marchand <david.marchand@redhat.com>
> Sent: Thursday, April 29, 2021 3:08 PM
> To: dev@dpdk.org
> Cc: thomas@monjalon.net; jerinj@marvell.com; Ruifeng Wang
> <Ruifeng.Wang@arm.com>; Jan Viktorin <viktorin@rehivetech.com>; Bruce
> Richardson <bruce.richardson@intel.com>; Pavan Nikhilesh
> <pbhagavatula@marvell.com>; Nithin Dabilpuram
> <ndabilpuram@marvell.com>; Lijun Ou <oulijun@huawei.com>; Chengchang
> Tang <tangchengchang@huawei.com>
> Subject: [PATCH] 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.
>
> Fixes: 1b4c86a721c9 ("config/arm: add Marvell CN10K")
> Fixes: 7cf32a22b240 ("config/arm: add Hisilicon kunpeng")
>
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
> config/arm/meson.build | 19 +++++++++++++++++++
> .../linux_gsg/cross_build_dpdk_for_arm64.rst | 18 +++++-------------
> 2 files changed, 24 insertions(+), 13 deletions(-)
>
> diff --git a/config/arm/meson.build b/config/arm/meson.build index
> 22cd81319c..fbe942e5ec 100644
> --- a/config/arm/meson.build
> +++ b/config/arm/meson.build
> @@ -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,
> diff --git a/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst
> b/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst
> index 3857cdefe9..958bc81784 100644
> --- a/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst
> +++ b/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst
> @@ -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
Thanks for the change. It is great help on doc maintenance.
Reviewed-by: Ruifeng Wang <ruifeng.wang@arm.com>
@@ -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,
@@ -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.::