DPDK patches and discussions
 help / color / mirror / Atom feed
* [dpdk-dev] [PATCH] doc: fix Arm socs list
@ 2021-04-29  7:07 David Marchand
  2021-04-29  9:22 ` Jerin Jacob
                   ` (3 more replies)
  0 siblings, 4 replies; 9+ messages in thread
From: David Marchand @ 2021-04-29  7:07 UTC (permalink / raw)
  To: dev
  Cc: thomas, Jerin Jacob, Ruifeng Wang, Jan Viktorin,
	Bruce Richardson, Pavan Nikhilesh, Nithin Dabilpuram, Lijun Ou,
	Chengchang Tang

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


^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [dpdk-dev] [PATCH] doc: fix Arm socs list
  2021-04-29  7:07 [dpdk-dev] [PATCH] doc: fix Arm socs list David Marchand
@ 2021-04-29  9:22 ` Jerin Jacob
  2021-04-29  9:54   ` Juraj Linkeš
  2021-04-29  9:53 ` Juraj Linkeš
                   ` (2 subsequent siblings)
  3 siblings, 1 reply; 9+ messages in thread
From: Jerin Jacob @ 2021-04-29  9:22 UTC (permalink / raw)
  To: David Marchand, Juraj Linkeš
  Cc: dpdk-dev, Thomas Monjalon, Jerin Jacob, Ruifeng Wang,
	Jan Viktorin, Bruce Richardson, Pavan Nikhilesh,
	Nithin Dabilpuram, Lijun Ou, Chengchang Tang

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
>

^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [dpdk-dev] [PATCH] doc: fix Arm socs list
  2021-04-29  7:07 [dpdk-dev] [PATCH] doc: fix Arm socs list David Marchand
  2021-04-29  9:22 ` Jerin Jacob
@ 2021-04-29  9:53 ` Juraj Linkeš
  2021-04-29  9:59   ` David Marchand
  2021-04-29 14:56 ` Ruifeng Wang
  2021-05-04 12:42 ` [dpdk-dev] [PATCH v2] " David Marchand
  3 siblings, 1 reply; 9+ messages in thread
From: Juraj Linkeš @ 2021-04-29  9:53 UTC (permalink / raw)
  To: David Marchand, dev
  Cc: thomas, Jerin Jacob, Ruifeng Wang, Jan Viktorin,
	Bruce Richardson, Pavan Nikhilesh, Nithin Dabilpuram, Lijun Ou,
	Chengchang Tang



> -----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
> 



^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [dpdk-dev] [PATCH] doc: fix Arm socs list
  2021-04-29  9:22 ` Jerin Jacob
@ 2021-04-29  9:54   ` Juraj Linkeš
  2021-04-29 11:41     ` Thomas Monjalon
  0 siblings, 1 reply; 9+ messages in thread
From: Juraj Linkeš @ 2021-04-29  9:54 UTC (permalink / raw)
  To: Jerin Jacob, David Marchand
  Cc: dpdk-dev, Thomas Monjalon, Jerin Jacob, Ruifeng Wang,
	Jan Viktorin, Bruce Richardson, Pavan Nikhilesh,
	Nithin Dabilpuram, Lijun Ou, Chengchang Tang



> -----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
> >


^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [dpdk-dev] [PATCH] doc: fix Arm socs list
  2021-04-29  9:53 ` Juraj Linkeš
@ 2021-04-29  9:59   ` David Marchand
  0 siblings, 0 replies; 9+ messages in thread
From: David Marchand @ 2021-04-29  9:59 UTC (permalink / raw)
  To: Juraj Linkeš
  Cc: dev, thomas, Jerin Jacob, Ruifeng Wang, Jan Viktorin,
	Bruce Richardson, Pavan Nikhilesh, Nithin Dabilpuram, Lijun Ou,
	Chengchang Tang

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).


-- 
David Marchand


^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [dpdk-dev] [PATCH] doc: fix Arm socs list
  2021-04-29  9:54   ` Juraj Linkeš
@ 2021-04-29 11:41     ` Thomas Monjalon
  0 siblings, 0 replies; 9+ messages in thread
From: Thomas Monjalon @ 2021-04-29 11:41 UTC (permalink / raw)
  To: Jerin Jacob, David Marchand, Juraj Linkeš
  Cc: dpdk-dev, Jerin Jacob, Ruifeng Wang, Jan Viktorin,
	Bruce Richardson, Pavan Nikhilesh, Nithin Dabilpuram, Lijun Ou,
	Chengchang Tang

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.




^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [dpdk-dev] [PATCH] doc: fix Arm socs list
  2021-04-29  7:07 [dpdk-dev] [PATCH] doc: fix Arm socs list David Marchand
  2021-04-29  9:22 ` Jerin Jacob
  2021-04-29  9:53 ` Juraj Linkeš
@ 2021-04-29 14:56 ` Ruifeng Wang
  2021-05-04 12:42 ` [dpdk-dev] [PATCH v2] " David Marchand
  3 siblings, 0 replies; 9+ messages in thread
From: Ruifeng Wang @ 2021-04-29 14:56 UTC (permalink / raw)
  To: David Marchand, dev
  Cc: thomas, jerinj, Jan Viktorin, Bruce Richardson, Pavan Nikhilesh,
	Nithin Dabilpuram, Lijun Ou, Chengchang Tang, nd

> -----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>

^ permalink raw reply	[flat|nested] 9+ messages in thread

* [dpdk-dev] [PATCH v2] doc: fix Arm socs list
  2021-04-29  7:07 [dpdk-dev] [PATCH] doc: fix Arm socs list David Marchand
                   ` (2 preceding siblings ...)
  2021-04-29 14:56 ` Ruifeng Wang
@ 2021-05-04 12:42 ` David Marchand
  2021-05-05 20:46   ` David Marchand
  3 siblings, 1 reply; 9+ messages in thread
From: David Marchand @ 2021-05-04 12:42 UTC (permalink / raw)
  To: dev
  Cc: thomas, Jerin Jacob, Ruifeng Wang, Jan Viktorin,
	Bruce Richardson, Juraj Linkeš,
	Honnappa Nagarahalli, Pavan Nikhilesh, Viacheslav Ovsiienko,
	Liron Himi, Nithin Dabilpuram, Lijun Ou, Chengchang Tang

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(-)

diff --git a/config/arm/meson.build b/config/arm/meson.build
index 22cd81319c..65f7ac672d 100644
--- a/config/arm/meson.build
+++ b/config/arm/meson.build
@@ -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,
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..274e793d7f 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: Start of socs list
+   :end-before: End of socs list
 
 These SoCs are also used in cross files, e.g.::
 
-- 
2.23.0


^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [dpdk-dev] [PATCH v2] doc: fix Arm socs list
  2021-05-04 12:42 ` [dpdk-dev] [PATCH v2] " David Marchand
@ 2021-05-05 20:46   ` David Marchand
  0 siblings, 0 replies; 9+ messages in thread
From: David Marchand @ 2021-05-05 20:46 UTC (permalink / raw)
  To: dev
  Cc: Thomas Monjalon, Jerin Jacob, Ruifeng Wang, Jan Viktorin,
	Bruce Richardson, Juraj Linkeš,
	Honnappa Nagarahalli, Pavan Nikhilesh, Viacheslav Ovsiienko,
	Liron Himi, Nithin Dabilpuram, Lijun Ou, Chengchang Tang

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
-- 
David Marchand


^ permalink raw reply	[flat|nested] 9+ messages in thread

end of thread, other threads:[~2021-05-05 20:46 UTC | newest]

Thread overview: 9+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-04-29  7:07 [dpdk-dev] [PATCH] doc: fix Arm socs list David Marchand
2021-04-29  9:22 ` Jerin Jacob
2021-04-29  9:54   ` Juraj Linkeš
2021-04-29 11:41     ` Thomas Monjalon
2021-04-29  9:53 ` Juraj Linkeš
2021-04-29  9:59   ` David Marchand
2021-04-29 14:56 ` Ruifeng Wang
2021-05-04 12:42 ` [dpdk-dev] [PATCH v2] " David Marchand
2021-05-05 20:46   ` David Marchand

DPDK patches and discussions

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://inbox.dpdk.org/dev/0 dev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 dev dev/ https://inbox.dpdk.org/dev \
		dev@dpdk.org
	public-inbox-index dev

Example config snippet for mirrors.
Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.dev


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git