From a952b01a0885da9cc89b637d78ee649aea437a95 Mon Sep 17 00:00:00 2001 From: John Levon Date: Sat, 25 Feb 2023 15:35:32 +0000 Subject: docs: document default_options behaviour As discussed in issue #8037, using `c_args` in `project()` leads to `CFLAGS` not being respected, which is a common mistake. Document this and suggest using `add_project_arguments()` instead. Signed-off-by: John Levon --- docs/yaml/functions/project.yaml | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'docs/yaml/functions') diff --git a/docs/yaml/functions/project.yaml b/docs/yaml/functions/project.yaml index c4ac0be..a18e878 100644 --- a/docs/yaml/functions/project.yaml +++ b/docs/yaml/functions/project.yaml @@ -49,6 +49,11 @@ kwargs: the master project, settings in subprojects are ignored. Project specific options are used normally even in subprojects. + Note that some options can override the default behavior; + for example, using `c_args` here means that the `CFLAGS` + environment variable is not used. Consider using + [[add_project_arguments()]] instead. + version: type: str | file description: | -- cgit v1.1