[v3] build: mention machine=default and its use in documentation

Message ID 20190418093020.18973-1-luca.boccassi@gmail.com
State Accepted, archived
Headers show
Series
  • [v3] build: mention machine=default and its use in documentation
Related show

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Luca Boccassi April 18, 2019, 9:30 a.m.
From: Luca Boccassi <bluca@debian.org>

Document the new value, as it's useful for distributions and users
who need to use a stable baseline -march

Signed-off-by: Luca Boccassi <bluca@debian.org>
Reviewed-by: Christian Ehrhardt <christian.ehrhardt@canonical.com>
Reviewed-by: Jerin Jacob <jerinj@marvell.com>
---
v2: fix typo, add commit body and reviewed-by
v3: added one more reviewed-by, reworded the note as suggested

 doc/build-sdk-meson.txt | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Thomas Monjalon April 18, 2019, 2:06 p.m. | #1
18/04/2019 11:30, luca.boccassi@gmail.com:
> From: Luca Boccassi <bluca@debian.org>
> 
> Document the new value, as it's useful for distributions and users
> who need to use a stable baseline -march
> 
> Signed-off-by: Luca Boccassi <bluca@debian.org>
> Reviewed-by: Christian Ehrhardt <christian.ehrhardt@canonical.com>
> Reviewed-by: Jerin Jacob <jerinj@marvell.com>
> ---
> v2: fix typo, add commit body and reviewed-by
> v3: added one more reviewed-by, reworded the note as suggested

Applied, thanks

Patch

diff --git a/doc/build-sdk-meson.txt b/doc/build-sdk-meson.txt
index 912cb3a8c..7b802442b 100644
--- a/doc/build-sdk-meson.txt
+++ b/doc/build-sdk-meson.txt
@@ -82,6 +82,8 @@  Project-specific options are passed used -Doption=value::
 
 	meson -Denable_docs=true fullbuild  # build and install docs
 
+	meson -Dmachine=default  # use builder-independent baseline -march
+
 Examples of setting the same options using meson configure::
 
 	meson configure -Dwerror=true
@@ -98,6 +100,9 @@  should be used to change the build settings within the directory, and when
 ``ninja`` is called to do the build itself, it will trigger the necessary
 re-scan from meson.
 
+NOTE: machine=default uses a config that works on all supported architectures
+regardless of the capabilities of the machine where the build is happening.
+
 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::