docs/meson: Recommend not using CFLAGS and friends
authorDylan Baker <dylan@pnwbakers.com>
Wed, 19 Dec 2018 21:27:27 +0000 (13:27 -0800)
committerDylan Baker <dylan@pnwbakers.com>
Thu, 20 Dec 2018 19:16:40 +0000 (11:16 -0800)
Because of the many caveats involved, using -Dc_args instead of CFLAGS
is recommended both by meson upstream and by us.

v2: - Fix typo

Reviewed-by: Bas Nieuwenhuizen <bas@basnieuwenhuizen.nl> (v1)
Reviewed-by: Eric Anholt <eric@anholt.net>
docs/meson.html

index 21e15ad1c1db1f6e85dab0a5f4677eafbfdd412a..63c106147d169dd8dc9b9bad88d0f5a2173bbce9 100644 (file)
@@ -110,14 +110,14 @@ to invoke non-default targets for ninja to update them:
 <dl>
 <dt><code>Environment Variables</code></dt>
 <dd><p>Meson supports the standard CC and CXX environment variables for
-changing the default compiler, and CFLAGS, CXXFLAGS, and LDFLAGS for setting
-options to the compiler and linker during the initial configuration.
-
-These arguments are consumed and stored by meson when it is initialized. To
-change these flags after the build is initialized (or when doing a first
-initialization), consider using <code>-D${lang}_args</code> and
-<code>-D${lang}_link_args</code> instead. Meson will never change compiler in a
-configured build directory.
+changing the default compiler. Meson does support CFLAGS, CXXFLAGS, etc. But
+their use is discouraged because of the many caveats in using them. Instead it
+is recomended to use <code>-D${lang}_args</code> and
+<code>-D${lang}_link_args</code> instead. Among the benefits of these options
+is that they are guaranteed to persist across rebuilds and reconfigurations.
+
+Meson does not allow changing compiler in a configured builddir, you will need
+to create a new build dir for a different compiler.
 </p>
 
 <pre>