Re: [PATCH 1/2] README: Explain how to build with meson

[David Gibson <david@gibson.dropbear.id.au>]

[-- Attachment #1: Type: text/plain, Size: 2846 bytes --]

On Wed, Oct 28, 2026 at 05:20:01AM -0600, Simon Glass wrote:
> Building with make is deprecated in favour of meson, but README.md only
> gives instructions for make, in its Python section, and CONTRIBUTING.md
> says to use 'make check'. The meson commands only appear in the warning
> which the Makefile prints.
> 
> Add a short Building section to README.md with the meson commands for
> building, testing and installing, pointing to the Meson quick guide and
> to scripts/install-deps.sh. Use meson for running the tests in
> CONTRIBUTING.md too.
> 
> Closes: https://github.com/dgibson/dtc/issues/83
> Assisted-by: Claude:claude-opus-5-5
> Signed-off-by: Simon Glass <sjg@chromium.org>

Reviewed-by: David Gibson <david@gibson.dropbear.id.au>

> ---
> 
>  CONTRIBUTING.md |  4 ++--
>  README.md       | 19 +++++++++++++++++++
>  2 files changed, 21 insertions(+), 2 deletions(-)
> 
> diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
> index 9742dc3..caf0210 100644
> --- a/CONTRIBUTING.md
> +++ b/CONTRIBUTING.md
> @@ -17,8 +17,8 @@ works with pylibfdt. If it cannot be supported, put the declaration in
>  
>  ## Tests
>  
> -Test files are kept in the `tests/` directory. Use `make check` to build and run
> -all tests.
> +Test files are kept in the `tests/` directory. Use `meson test -C build` to
> +build and run all tests (see [README.md](README.md#building)).
>  
>  If you want to adjust a test file, be aware that `tree_tree1.dts` is compiled
>  and checked against a binary tree from assembler macros in `trees.S`. So
> diff --git a/README.md b/README.md
> index 8f1a5d2..ed9039d 100644
> --- a/README.md
> +++ b/README.md
> @@ -8,6 +8,25 @@ dtc and libfdt are maintained by:
>  
>  * [David Gibson `<david@gibson.dropbear.id.au>`](mailto:david@gibson.dropbear.id.au)
>  
> +## Building
> +
> +dtc and libfdt are built with [Meson](https://mesonbuild.com/):
> +
> +```
> +$ meson setup build
> +$ meson compile -C build
> +$ meson test -C build
> +$ meson install -C build
> +```
> +
> +`meson configure build` lists the build options, e.g. `-Dpython=disabled`
> +to skip the Python library. See the
> +[Meson quick guide](https://mesonbuild.com/Quick-guide.html) for more,
> +such as installing with `--destdir`. `scripts/install-deps.sh` installs
> +the packages needed on common systems.
> +
> +Building with `make` still works but is deprecated.
> +
>  ## Python library
>  
>  A Python library wrapping libfdt is also available. To build this you
> ---
> base-commit: 1d50f3f8fa8bf9429eebb0769dafa5df37381ae1
> branch: readme-meson
> 
> -- 
> 2.43.0
> 
> 

-- 
David Gibson (he or they)	| I'll have my music baroque, and my code
david AT gibson.dropbear.id.au	| minimalist, thank you, not the other way
				| around.
http://www.ozlabs.org/~dgibson

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]