diff options
Diffstat (limited to 'docs/markdown')
| -rw-r--r-- | docs/markdown/Reference-manual.md | 12 | ||||
| -rw-r--r-- | docs/markdown/snippets/force_system.md | 11 |
2 files changed, 23 insertions, 0 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md index cd87646..862c60a 100644 --- a/docs/markdown/Reference-manual.md +++ b/docs/markdown/Reference-manual.md @@ -464,6 +464,12 @@ arguments: You can also specify multiple restrictions by passing a list to this keyword argument, such as: `['>=3.14.0', '<=4.1.0']`. These requirements are never met if the version is unknown. +- `include_type` *(added 0.52.0)* is an enum flag, marking how the dependency + flags should be converted. Supported values are `'preserve'`, `'system'` and + `'non-system'`. System dependencies may be handled differently on some + platforms, for instance, using `-isystem` instead of `-I`, where possible. + If `include_type` is set to `'preserve'`, no additional conversion will be + performed. The default value is `'preserve'`. - other [library-specific](Dependencies.md#dependencies-with-custom-lookup-functionality) keywords may also be accepted (e.g. `modules` specifies submodules to use for @@ -2227,6 +2233,12 @@ an external dependency with the following methods: `unknown` if the dependency provider doesn't support determining the version. + - `include_type()` returns whether the value set by the `include_type` kwarg + + - `as_system(value)` returns a copy of the dependency object, which has changed + the value of `include_type` to `value`. The `value` argument is optional and + defaults to `'preserve'`. + - `partial_dependency(compile_args : false, link_args : false, links : false, includes : false, source : false)` *(Added 0.46.0)* returns a new dependency object with the same name, version, found status, diff --git a/docs/markdown/snippets/force_system.md b/docs/markdown/snippets/force_system.md new file mode 100644 index 0000000..fd983e0 --- /dev/null +++ b/docs/markdown/snippets/force_system.md @@ -0,0 +1,11 @@ +## Added `include_type` kwarg to `dependency` + +The `dependency()` function now has a `include_type` kwarg. It can take the +values `'preserve'`, `'system'` and `'non-system'`. If it is set to `'system'`, +all include directories of the dependency are marked as system dependencies. + +The default value of `include_type` is `'preserve'`. + +Additionally, it is also possible to check and change the `include_type` +state of an existing dependency object with the new `include_type()` and +`as_system()` methods. |