[dpdk-dev] [PATCH] doc: fix Arm socs list

[Ruifeng Wang]

> -----Original Message-----
> From: David Marchand <david.marchand at redhat.com>
> Sent: Thursday, April 29, 2021 3:08 PM
> To: dev at dpdk.org
> Cc: thomas at monjalon.net; jerinj at marvell.com; Ruifeng Wang
> <Ruifeng.Wang at arm.com>; Jan Viktorin <viktorin at rehivetech.com>; Bruce
> Richardson <bruce.richardson at intel.com>; Pavan Nikhilesh
> <pbhagavatula at marvell.com>; Nithin Dabilpuram
> <ndabilpuram at marvell.com>; Lijun Ou <oulijun at huawei.com>; Chengchang
> Tang <tangchengchang at 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 at 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 at arm.com>