[v2] doc: update machine meson option in prog guide
Checks
Commit Message
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
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.
> -----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.
@@ -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::