build: mention machine=default and its use in documentation

Message ID 20190114112331.15761-1-bluca@debian.org (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series build: mention machine=default and its use in documentation |

Checks

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

Commit Message

Luca Boccassi Jan. 14, 2019, 11:23 a.m. UTC
  Signed-off-by: Luca Boccassi <bluca@debian.org>
---
 doc/build-sdk-meson.txt | 5 +++++
 1 file changed, 5 insertions(+)
  

Comments

Christian Ehrhardt Jan. 14, 2019, 1:32 p.m. UTC | #1
On Mon, Jan 14, 2019 at 1:23 PM Luca Boccassi <bluca@debian.org> wrote:
>
> Signed-off-by: Luca Boccassi <bluca@debian.org>
> ---
>  doc/build-sdk-meson.txt | 5 +++++
>  1 file changed, 5 insertions(+)
>
> diff --git a/doc/build-sdk-meson.txt b/doc/build-sdk-meson.txt
> index 29a8bd387..2efff58e2 100644
> --- a/doc/build-sdk-meson.txt
> +++ b/doc/build-sdk-meson.txt
> @@ -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:
Reviewed-by: Christian Ehrhardt <christian.ehrhardt@canonical.com>

> +
>  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
>
  
Luca Boccassi Jan. 14, 2019, 1:44 p.m. UTC | #2
On Mon, 2019-01-14 at 15:32 +0200, Christian Ehrhardt wrote:
> On Mon, Jan 14, 2019 at 1:23 PM Luca Boccassi <bluca@debian.org>
> wrote:
> > 
> > Signed-off-by: Luca Boccassi <bluca@debian.org>
> > ---
> >  doc/build-sdk-meson.txt | 5 +++++
> >  1 file changed, 5 insertions(+)
> > 
> > diff --git a/doc/build-sdk-meson.txt b/doc/build-sdk-meson.txt
> > index 29a8bd387..2efff58e2 100644
> > --- a/doc/build-sdk-meson.txt
> > +++ b/doc/build-sdk-meson.txt
> > @@ -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:
> Reviewed-by: Christian Ehrhardt <christian.ehrhardt@canonical.com>

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

Patch

diff --git a/doc/build-sdk-meson.txt b/doc/build-sdk-meson.txt
index 29a8bd387..2efff58e2 100644
--- a/doc/build-sdk-meson.txt
+++ b/doc/build-sdk-meson.txt
@@ -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::