diff options
| author | John Levon <levon@movementarian.org> | 2023-02-25 15:35:32 +0000 |
|---|---|---|
| committer | Dylan Baker <dylan@pnwbakers.com> | 2023-03-01 12:15:40 -0800 |
| commit | a952b01a0885da9cc89b637d78ee649aea437a95 (patch) | |
| tree | 9e8c2054d80f29b3403733e1c036c796fca60fae /docs/yaml/functions/project.yaml | |
| parent | 8833513f574664e510fd1dc246aa669b2cd80fbf (diff) | |
| download | meson-a952b01a0885da9cc89b637d78ee649aea437a95.zip meson-a952b01a0885da9cc89b637d78ee649aea437a95.tar.gz meson-a952b01a0885da9cc89b637d78ee649aea437a95.tar.bz2 | |
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 <levon@movementarian.org>
Diffstat (limited to 'docs/yaml/functions/project.yaml')
| -rw-r--r-- | docs/yaml/functions/project.yaml | 5 |
1 files changed, 5 insertions, 0 deletions
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: | |