From 0152aa56731a7c2c6f8afe7211b9861731124fbb Mon Sep 17 00:00:00 2001 From: Peter Krempa Date: Mon, 4 Sep 2023 12:09:11 +0200 Subject: [PATCH] docs: compiling: Add a note about use of CFLAGS for optimization MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Meson doesn't interpret what's set in CFLAGS, but rather simply appeds it to the command line. Thus any logic which is based on the optimization level will not work. Note the caveat in the docs and instruct users to use ``--optimization=N`` instead. Signed-off-by: Peter Krempa Reviewed-by: Daniel P. Berrangé --- docs/compiling.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/compiling.rst b/docs/compiling.rst index 800264d2f9..0a47a50569 100644 --- a/docs/compiling.rst +++ b/docs/compiling.rst @@ -112,6 +112,11 @@ Please ensure that you have the appropriate minimal ``meson`` version installed in your build environment. The minimal version for a specific package can be checked in the top level ``meson.build`` file in the ``meson_version`` field. +**DO NOT** use the ``CFLAGS`` environment variable to set optimizations +(e.g. ``CFLAGS=-O0``), but rather use Meson's ``--optimization=0`` option. +Certain internal build options are based on the configured optimization value +and Meson does not interpret ``CFLAGS``. + Compiling the sources ---------------------