include_directories()
Returns an opaque object which contains the directories (relative to
the current directory) given in the positional arguments. The result
can then be passed to the include_directories: keyword argument when
building executables or libraries. You can use the returned object in
any subdirectory you want, Meson will make the paths work
automatically.
Note that this function call itself does not add the directories into
the search path, since there is no global search path. For something
like that, see add_project_arguments().
See also implicit_include_directories parameter of
executable(), which adds current source and build
directories to include path.
Each directory given is converted to two include paths: one that is relative to the source root and one relative to the build root.
Signature
# Returns an opaque object which contains the directories (relative to
inc include_directories(
str includes..., # Include paths to add
# Keyword arguments:
is_system : bool # If set to `true`, flags the specified directories as system directories
)
Example
For example, with the following source tree layout in
/home/user/project.git:
meson.build:
project(...)
subdir('include')
subdir('src')
...
include/meson.build:
inc = include_directories('.')
...
src/meson.build:
sources = [...]
executable('some-tool', sources,
include_directories : inc,
...)
...
If the build tree is /tmp/build-tree, the following include paths
will be added to the executable() call: -I/tmp/build-tree/include -I/home/user/project.git/include.
Arguments
The
function accepts between 0 and infinity variadic
arguments (includes...) of type .str
Include paths to add.
The function include_directories()
accepts the following keyword arguments:
| Name | Type | Description | Tags |
|---|---|---|---|
is_system |
bool |
If set to |
|
The results of the search are