[v3,2/3] doc/guides: add dpdk build instruction for AMD platforms

Message ID 20211026155645.246783-2-aman.kumar@vvdntech.in (mailing list archive)
State Superseded, archived
Headers
Series [v3,1/3] config/x86: add support for AMD platform |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Aman Kumar Oct. 26, 2021, 3:56 p.m. UTC
linux guide updated with AMD platform related build
instructions.

Signed-off-by: Aman Kumar <aman.kumar@vvdntech.in>
---
 doc/guides/linux_gsg/build_dpdk.rst | 4 ++++
 1 file changed, 4 insertions(+)
  

Comments

Thomas Monjalon Oct. 26, 2021, 4:07 p.m. UTC | #1
26/10/2021 17:56, Aman Kumar:
> linux guide updated with AMD platform related build
> instructions.
> 
> Signed-off-by: Aman Kumar <aman.kumar@vvdntech.in>
> ---
>  doc/guides/linux_gsg/build_dpdk.rst | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/doc/guides/linux_gsg/build_dpdk.rst b/doc/guides/linux_gsg/build_dpdk.rst
> index 0b08492ca2..3110448467 100644
> --- a/doc/guides/linux_gsg/build_dpdk.rst
> +++ b/doc/guides/linux_gsg/build_dpdk.rst
> @@ -113,6 +113,10 @@ The instruction set will be set automatically by default according to these rule
>  To override what instruction set will be used, set the ``cpu_instruction_set``
>  parameter to the instruction set of your choice (such as ``corei7``, ``power8``, etc.).

All possible values are not documented here.
If you want to mention znverX, I suggest just adding znver3 after corei7 above,
and remove the lines below.
Note: such change should be squashed with the meson change.

> +To build dpdk for AMD Zen CPU based platforms, pass ``-Dcpu_instruction_set=<znverX>``

s/dpdk/DPDK/

> +to meson when configuring the build folder initially. Supported options are znver1,
> +znver2 and znver3.

You can start a new line when starting a new sentence.

If you want to document AMD platform, you can add a file in
	doc/guides/platform/
For describing tuning on Linux you can do the same as
	doc/guides/linux_gsg/nic_perf_intel_platform.rst
  
Aman Kumar Oct. 27, 2021, 6:30 a.m. UTC | #2
On Tue, Oct 26, 2021 at 9:37 PM Thomas Monjalon <thomas@monjalon.net> wrote:

> 26/10/2021 17:56, Aman Kumar:
> > linux guide updated with AMD platform related build
> > instructions.
> >
> > Signed-off-by: Aman Kumar <aman.kumar@vvdntech.in>
> > ---
> >  doc/guides/linux_gsg/build_dpdk.rst | 4 ++++
> >  1 file changed, 4 insertions(+)
> >
> > diff --git a/doc/guides/linux_gsg/build_dpdk.rst
> b/doc/guides/linux_gsg/build_dpdk.rst
> > index 0b08492ca2..3110448467 100644
> > --- a/doc/guides/linux_gsg/build_dpdk.rst
> > +++ b/doc/guides/linux_gsg/build_dpdk.rst
> > @@ -113,6 +113,10 @@ The instruction set will be set automatically by
> default according to these rule
> >  To override what instruction set will be used, set the
> ``cpu_instruction_set``
> >  parameter to the instruction set of your choice (such as ``corei7``,
> ``power8``, etc.).
>
> All possible values are not documented here.
> If you want to mention znverX, I suggest just adding znver3 after corei7
> above,
> and remove the lines below.
> Note: such change should be squashed with the meson change.
>

Noted. Will squash this with meson changes.

>
> > +To build dpdk for AMD Zen CPU based platforms, pass
> ``-Dcpu_instruction_set=<znverX>``
>
> s/dpdk/DPDK/
>
> > +to meson when configuring the build folder initially. Supported options
> are znver1,
> > +znver2 and znver3.
>
> You can start a new line when starting a new sentence.
>
> If you want to document AMD platform, you can add a file in
>         doc/guides/platform/
> For describing tuning on Linux you can do the same as
>         doc/guides/linux_gsg/nic_perf_intel_platform.rst
>
> For now, the above entry in the build_dpdk.rst will suffice.
We will add a separate platform doc once we have more platform specific
items.
  

Patch

diff --git a/doc/guides/linux_gsg/build_dpdk.rst b/doc/guides/linux_gsg/build_dpdk.rst
index 0b08492ca2..3110448467 100644
--- a/doc/guides/linux_gsg/build_dpdk.rst
+++ b/doc/guides/linux_gsg/build_dpdk.rst
@@ -113,6 +113,10 @@  The instruction set will be set automatically by default according to these rule
 To override what instruction set will be used, set the ``cpu_instruction_set``
 parameter to the instruction set of your choice (such as ``corei7``, ``power8``, etc.).
 
+To build dpdk for AMD Zen CPU based platforms, pass ``-Dcpu_instruction_set=<znverX>``
+to meson when configuring the build folder initially. Supported options are znver1,
+znver2 and znver3.
+
 ``cpu_instruction_set`` is not used in Arm builds, as setting the instruction set
 without other parameters leads to inferior builds. The way to tailor Arm builds
 is to build for a SoC using ``-Dplatform=<SoC>`` mentioned above.