diff mbox series

[v2] doc: update machine meson option in prog guide

Message ID 1633959747-28723-1-git-send-email-juraj.linkes@pantheon.tech (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers show
Series [v2] doc: update machine meson option in prog guide | expand

Checks

Context Check Description
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-testing success Testing PASS
ci/intel-Testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-spell-check-testing warning Testing issues
ci/iol-broadcom-Functional success Functional Testing PASS
ci/github-robot: build success github build: passed
ci/checkpatch success coding style OK

Commit Message

Juraj Linkeš Oct. 11, 2021, 1:42 p.m. UTC
Update the docs to reflect the two new variables, cpu_instruction_set
for non-arm builds and platform for arm builds.

Fixes: bf66003b51ec ("build: use platform for generic and native builds")

Signed-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech>
---
v2: ci retest
---
 doc/guides/prog_guide/build-sdk-meson.rst | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

Comments

Thomas Monjalon Nov. 26, 2021, 1:41 p.m. UTC | #1
11/10/2021 15:42, Juraj Linkeš:
> Update the docs to reflect the two new variables, cpu_instruction_set
> for non-arm builds and platform for arm builds.
> 
> Fixes: bf66003b51ec ("build: use platform for generic and native builds")
> 
> Signed-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech>
> ---
> --- a/doc/guides/prog_guide/build-sdk-meson.rst
> +++ b/doc/guides/prog_guide/build-sdk-meson.rst
> -	meson -Dmachine=generic  # use builder-independent baseline -march
> +	meson -Dcpu_instruction_set=generic  # use builder-independent
> +					# baseline -march
[...]
>  .. note::
> -        machine=generic uses a config that works on all supported architectures
> -        regardless of the capabilities of the machine where the build is happening.
> +        cpu_instruction_set=generic uses an instruction set that works on all
> +        supported architectures regardless of the capabilities of the machine
> +        where the build is happening.
>  
> +.. note::
> +       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>.
> +
> +]

I assume this last line is a typo.

I would prefer having an Ack from Arm, but it did not happen.

Applied, thanks.
Juraj Linkeš Nov. 26, 2021, 2:16 p.m. UTC | #2
> -----Original Message-----
> From: Thomas Monjalon <thomas@monjalon.net>
> Sent: Friday, November 26, 2021 2:41 PM
> To: Juraj Linkeš <juraj.linkes@pantheon.tech>
> Cc: david.marchand@redhat.com; bruce.richardson@intel.com; dev@dpdk.org;
> honnappa.nagarahalli@arm.com; Ruifeng Wang <ruifeng.wang@arm.com>
> Subject: Re: [dpdk-dev] [PATCH v2] doc: update machine meson option in prog
> guide
> 
> 11/10/2021 15:42, Juraj Linkeš:
> > Update the docs to reflect the two new variables, cpu_instruction_set
> > for non-arm builds and platform for arm builds.
> >
> > Fixes: bf66003b51ec ("build: use platform for generic and native
> > builds")
> >
> > Signed-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech>
> > ---
> > --- a/doc/guides/prog_guide/build-sdk-meson.rst
> > +++ b/doc/guides/prog_guide/build-sdk-meson.rst
> > -	meson -Dmachine=generic  # use builder-independent baseline -march
> > +	meson -Dcpu_instruction_set=generic  # use builder-independent
> > +					# baseline -march
> [...]
> >  .. note::
> > -        machine=generic uses a config that works on all supported architectures
> > -        regardless of the capabilities of the machine where the build is
> happening.
> > +        cpu_instruction_set=generic uses an instruction set that works on all
> > +        supported architectures regardless of the capabilities of the machine
> > +        where the build is happening.
> >
> > +.. note::
> > +       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>.
> > +
> > +]
> 
> I assume this last line is a typo.

Yes, the square bracket shouldn't be there.

> 
> I would prefer having an Ack from Arm, but it did not happen.
> 
> Applied, thanks.
> 
> 

Thanks.
diff mbox series

Patch

diff --git a/doc/guides/prog_guide/build-sdk-meson.rst b/doc/guides/prog_guide/build-sdk-meson.rst
index 877a64b061..0f5ce599be 100644
--- a/doc/guides/prog_guide/build-sdk-meson.rst
+++ b/doc/guides/prog_guide/build-sdk-meson.rst
@@ -91,7 +91,8 @@  Project-specific options are passed used -Doption=value::
 
 	meson -Denable_docs=true fullbuild  # build and install docs
 
-	meson -Dmachine=generic  # use builder-independent baseline -march
+	meson -Dcpu_instruction_set=generic  # use builder-independent
+					# baseline -march
 
 	meson -Ddisable_drivers=event/*,net/tap  # disable tap driver and all
 					# eventdev PMDs for a smaller build
@@ -120,9 +121,16 @@  Examples of setting some of the same options using meson configure::
         re-scan from meson.
 
 .. note::
-        machine=generic uses a config that works on all supported architectures
-        regardless of the capabilities of the machine where the build is happening.
+        cpu_instruction_set=generic uses an instruction set that works on all
+        supported architectures regardless of the capabilities of the machine
+        where the build is happening.
 
+.. note::
+       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>.
+
+]
 As well as those settings taken from ``meson configure``, other options
 such as the compiler to use can be passed via environment variables. For
 example::