From 942f145de9744b2ffce0c01e153b18a6ea471b9d Mon Sep 17 00:00:00 2001 From: Daniel Mensinger Date: Tue, 24 Sep 2019 23:12:01 +0200 Subject: added docs --- docs/markdown/Reference-manual.md | 11 +++++++++++ docs/markdown/snippets/is_system.md | 9 +++++++++ 2 files changed, 20 insertions(+) create mode 100644 docs/markdown/snippets/is_system.md diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md index 176cde4..25c803d 100644 --- a/docs/markdown/Reference-manual.md +++ b/docs/markdown/Reference-manual.md @@ -461,6 +461,10 @@ 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. +- `is_system` *(added 0.52.0)* is a boolean flag, marking the dependency + as a system dependency. System dependencies may be handled differently + on some platforms, for instance using `-isystem` instead of `-I`, where + possible. The default value is `false`. - other [library-specific](Dependencies.md#dependencies-with-custom-lookup-functionality) keywords may also be accepted (e.g. `modules` specifies submodules to use for @@ -2224,6 +2228,13 @@ an external dependency with the following methods: `unknown` if the dependency provider doesn't support determining the version. + - `is_system()` returns whether the dependency object was marked as a + system dependency + + - `as_system(value)` returns a copy of the dependency object, which has changed + the value of `is_system` to `value`. The `value` argument is optional and + defaults to `true`. + - `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/is_system.md b/docs/markdown/snippets/is_system.md new file mode 100644 index 0000000..cb1da0a --- /dev/null +++ b/docs/markdown/snippets/is_system.md @@ -0,0 +1,9 @@ +## Added `is_system` kwarg to `dependency` + +Similar to `include_directories()`, the `dependency()` function now +also has a `is_system` kwarg. If it is enabled, all include directories +of the dependency are marked as system dependencies. + +Additionally, it is also possible to check and change the `is_system` +state of an existing dependency object with the new `is_system()` and +`as_system()` methods. -- cgit v1.1