Debian Codegraph @

subprojects/meson-docs/docs/yaml/functions/install_headers.yaml

raw
1 name: install_headers
2 returns: void
3 description: |
4 Installs the specified header files from the source tree into the
5 system header directory (usually `/{prefix}/include`) during the
6 install step. This directory can be overridden by specifying it with
7 the `install_dir` keyword argument. If you just want to install into a
8 subdirectory of the system header directory, then use the `subdir`
9 argument. As an example if this has the value `myproj` then the
10 headers would be installed to `/{prefix}/include/myproj`.
11
12 example: |
13 For example, this will install `common.h` and `kola.h` into
14 `/{prefix}/include`:
15
16 ```meson
17 install_headers('common.h', 'proj/kola.h')
18 ```
19
20 This will install `common.h` and `kola.h` into `/{prefix}/include/myproj`:
21
22 ```meson
23 install_headers('common.h', 'proj/kola.h', subdir : 'myproj')
24 ```
25
26 This will install `common.h` and `kola.h` into `/{prefix}/cust/myproj`:
27
28 ```meson
29 install_headers('common.h', 'proj/kola.h', install_dir : 'cust', subdir : 'myproj')
30 ```
31
32 This will install `common.h` into `/{prefix}/include` and `kola.h`
33 into `/{prefix}/include/proj/`:
34
35 ```meson
36 install_headers('common.h, 'proj/kola.h', preserve_path : true)
37 ```
38
39 varargs:
40 name: file
41 type: file | str
42 description: Header files to install.
43
44 warnings:
45 - the `install_mode` kwarg ignored integer values between 0.59.0 -- 1.1.0.
46
47 kwargs:
48 install_dir:
49 type: str
50 description: Where to install to.
51
52 subdir:
53 type: str
54 description: |
55 Install to the `subdir` subdirectory of the default includedir.
56
57 Incompatible with the `install_dir` kwarg.
58
59 install_mode:
60 type: list[str | int | bool]
61 since: 0.47.0
62 description: |
63 Specify the file mode in symbolic format
64 and optionally the owner/uid and group/gid for the installed files.
65
66 See the `install_mode` kwarg of [[install_data]] for more information.
67
68 preserve_path:
69 type: bool
70 since: 0.63.0
71 default: false
72 description: |
73 Disable stripping child-directories from header files when installing.
74
75 This is equivalent to GNU Automake's `nobase` option.
76
77 follow_symlinks:
78 type: bool
79 since: 1.3.0
80 default: true
81 description: |
82 If true, dereferences links and copies their target instead. The default
83 value will become false in the future.