Skip to contentSkip to conversation

build: mention machine=default and its use in documentation

PATCH Superseded Luca Boccassi 5 participants 10 messages Jan 14, 2019 – Apr 18, 2019 Arm/Amlogic Meson SoC support

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 build: mention machine=default and its use in documentation

---
 doc/build-sdk-meson.txt | 5 +++++
 1 file changed, 5 insertions(+)
doc/build-sdk-meson.txt +5 -0
index 29a8bd387..2efff58e2 100644
@@ -87,6 +87,8 @@ Project-specific options are passed used -Doption=value::
 
 	meson -Denable_docs=true fullbuild  # build and install docs
 
+	meson -Dmachine=default  # user builder-independent baseline -march
+
 Examples of setting the same options using meson configure::
 
 	meson configure -Dwerror=true
@@ -103,6 +105,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 will use the minimum required -march on all 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::
Signature · 1 line
2.20.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 11 lines · Luca Boccassi
---
 doc/build-sdk-meson.txt | 5 +++++
 1 file changed, 5 insertions(+)
doc/build-sdk-meson.txt +0 -0
index 29a8bd387..2efff58e2 100644

doc/build-sdk-meson.txt Project-specific options are passed used -Doption=value:: · line 90

Quoted 4 lines
doc/build-sdk-meson.txt +1 -0
@@ -87,6 +87,8 @@ Project-specific options are passed used -Doption=value::
 
        meson -Denable_docs=true fullbuild  # build and install docs
 
+       meson -Dmachine=default  # user builder-independent baseline -march

Thanks for driving all the proper builder independent config Luca. In this line I'd assume you meant "use" not "user" right?

Other than that:

Quoted 17 lines
doc/build-sdk-meson.txt +4 -1
+
 Examples of setting the same options using meson configure::
 
        meson configure -Dwerror=true
@@ -103,6 +105,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 will use the minimum required -march on all 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::
--

2.20.1

Signature · 3 lines
Christian Ehrhardt
Software Engineer, Ubuntu Server
Canonical Ltd
#2 lore raw
Quoted 18 lines · Christian Ehrhardt
Quoted 16 lines · Luca Boccassi

---
 doc/build-sdk-meson.txt | 5 +++++

 1 file changed, 5 insertions(+)
doc/build-sdk-meson.txt +0 -1
index 29a8bd387..2efff58e2 100644
@@ -87,6 +87,8 @@ Project-specific options are passed used
-Doption=value::
 

        meson -Denable_docs=true fullbuild  # build and install docs

Quoted 8 lines
Quoted 2 lines

+       meson -Dmachine=default  # user builder-independent baseline -march

Thanks for driving all the proper builder independent config Luca. In this line I'd assume you meant "use" not "user" right?

Other than that:

Yes indeed it's a typo, fixed in v2, thanks

Signature · 2 lines
Kind regards,
Luca Boccassi
#3 lore raw

PATCH v2 1/1 build: mention machine=default and its use in documentation

In reply to Luca Boccassi

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

---
v2: fix typo, add commit body and reviewed-by

 doc/build-sdk-meson.txt | 5 +++++
 1 file changed, 5 insertions(+)
doc/build-sdk-meson.txt +5 -0
index 29a8bd387..ab33ca82a 100644
@@ -87,6 +87,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
@@ -103,6 +105,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 will use the minimum required -march on all 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::
Signature · 1 line
2.20.1
#4 lore raw
Quoted 32 lines · Luca Boccassi

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

---
v2: fix typo, add commit body and reviewed-by

 doc/build-sdk-meson.txt | 5 +++++
 1 file changed, 5 insertions(+)
doc/build-sdk-meson.txt +2 -2
index 29a8bd387..ab33ca82a 100644
@@ -87,6 +87,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
@@ -103,6 +105,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.

Quoted 10 lines

+NOTE: machine=default will use the minimum required -march on all 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::

Ping - anything else I can do for this patch? Thanks!

Signature · 2 lines
Kind regards,
Luca Boccassi
#6 lore raw
In reply to Luca Boccassi

14/01/2019 14:41, Luca Boccassi:

doc/build-sdk-meson.txt should be used to change the build settings within the directory, and when · line 109

Quoted 8 lines

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

---

doc/build-sdk-meson.txt +2 -0
+NOTE: machine=default will use the minimum required -march on all architectures
+regardless of the capabilities of the machine where the build is happening.

This option is not really selecting the minimum but something which works on every flavours of the CPU architecture.
For instance, on ARM it can select a cacheline of 128B to make it work with 64B and 128B micro-architectures.

After discussing with Bruce and Luca I was convinced that "default" is not a good name, and "machine=any" would be better. The name "default" may also refer, in some contexts, to the config of the basic/standard CPU design.
Even worst, "default" is not the default machine in DPDK...

Today I am not sure what is the best meaningful name, and I tend to think that "default" is well understood by everyone. So I am OK to apply this patch, but please replace
"minimum required -march"
by
"config working"
or something similar, thanks.

#7 lore raw
Quoted 29 lines · Thomas Monjalon

14/01/2019 14:41, Luca Boccassi:

Quoted 6 lines

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 <
[email protected]

Quoted 1 line
Quoted 8 lines

Reviewed-by: Christian Ehrhardt <
[email protected]

Quoted 1 line

---
+NOTE: machine=default will use the minimum required -march on all architectures
+regardless of the capabilities of the machine where the build is happening.

This option is not really selecting the minimum but something which works
on every flavours of the CPU architecture.
For instance, on ARM it can select a cacheline of 128B to make it work
with 64B and 128B micro-architectures.

After discussing with Bruce and Luca I was convinced that "default" is not a good name, and "machine=any" would be better. The name "default" may also refer, in some contexts, to the config of the basic/standard CPU design.
Even worst, "default" is not the default machine in DPDK...

Quoted 7 lines

Today I am not sure what is the best meaningful name, and I tend to think that "default" is well understood by everyone. So I am OK to apply this patch, but please replace
"minimum required -march"
by
"config working"
or something similar, thanks.

No problem, updated in v3, thanks.

Signature · 2 lines
Kind regards,
Luca Boccassi
#8 lore raw

PATCH v3 1/1 build: mention machine=default and its use in documentation

In reply to Luca Boccassi

From: Luca Boccassi <[email protected]>

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

---
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(+)
doc/build-sdk-meson.txt +5 -0
index 912cb3a8c..7b802442b 100644
@@ -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::
Signature · 1 line
2.20.1
#9 lore raw

18/04/2019 11:30, [email protected]:

Quoted 11 lines

From: Luca Boccassi <[email protected]>

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

---
v2: fix typo, add commit body and reviewed-by
v3: added one more reviewed-by, reworded the note as suggested

Applied, thanks