]> git.droids-corp.org - dpdk.git/commitdiff
doc: replace machine option in build guide
authorJuraj Linkeš <juraj.linkes@pantheon.tech>
Mon, 11 Oct 2021 13:42:27 +0000 (15:42 +0200)
committerThomas Monjalon <thomas@monjalon.net>
Fri, 26 Nov 2021 14:10:16 +0000 (15:10 +0100)
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>
doc/guides/prog_guide/build-sdk-meson.rst

index 877a64b061bc214c46a15bdef7c6051c75c35ff4..30ce8059025856f93d0e420c3d50cc81e6aacf4a 100644 (file)
@@ -91,7 +91,7 @@ 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,8 +120,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