diff mbox series

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

Message ID 1633419847-13109-1-git-send-email-juraj.linkes@pantheon.tech (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series [v1] doc: update machine meson option in prog guide |

Checks

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

Commit Message

Juraj Linkeš Oct. 5, 2021, 7:44 a.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>
---
 doc/guides/prog_guide/build-sdk-meson.rst | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)
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::