aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown
diff options
context:
space:
mode:
authorDaniel Mensinger <daniel@mensinger-ka.de>2019-09-29 21:27:05 +0200
committerDaniel Mensinger <daniel@mensinger-ka.de>2019-10-03 10:06:04 +0200
commit73d52266b5cf8e6b62d715328f0c66b1734c3026 (patch)
treeb8e0b6cbc1d9c378c802c235fdbb2713cbee7a7c /docs/markdown
parente5c720ff607cdf3101de031ff3a36f434d77b0d1 (diff)
downloadmeson-73d52266b5cf8e6b62d715328f0c66b1734c3026.zip
meson-73d52266b5cf8e6b62d715328f0c66b1734c3026.tar.gz
meson-73d52266b5cf8e6b62d715328f0c66b1734c3026.tar.bz2
Use include_type instead of is_system
Diffstat (limited to 'docs/markdown')
-rw-r--r--docs/markdown/Reference-manual.md17
-rw-r--r--docs/markdown/snippets/force_system.md11
-rw-r--r--docs/markdown/snippets/is_system.md9
3 files changed, 20 insertions, 17 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index 25c803d..c50a611 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -461,10 +461,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.
-- `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`.
+- `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
@@ -2228,12 +2230,11 @@ 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
+ - `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 `is_system` to `value`. The `value` argument is optional and
- defaults to `true`.
+ 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
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.
diff --git a/docs/markdown/snippets/is_system.md b/docs/markdown/snippets/is_system.md
deleted file mode 100644
index cb1da0a..0000000
--- a/docs/markdown/snippets/is_system.md
+++ /dev/null
@@ -1,9 +0,0 @@
-## 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.