Chiebot-Mirror
/
meson
mirror of https://github.com/mesonbuild/meson.git
8
0
Fork 0
Code Issues Projects Releases Wiki Activity
The Meson Build System http://mesonbuild.com/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
14672 Commits
76 Branches
171 Tags
74 MiB
Tag: Branch: Tree: f8aefe2070
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'f8aefe2070'
${ noResults }
meson/docs/yaml/functions/install_headers.yaml

84 lines
2.3 KiB
Raw Normal View History Unescape

docs: Add the YAML Reference manual
3 years ago
name: install_headers
returns: void
description: |
Installs the specified header files from the source tree into the
system header directory (usually `/{prefix}/include`) during the
install step. This directory can be overridden by specifying it with
the `install_dir` keyword argument. If you just want to install into a
subdirectory of the system header directory, then use the `subdir`
argument. As an example if this has the value `myproj` then the
headers would be installed to `/{prefix}/include/myproj`.
example: |
For example, this will install `common.h` and `kola.h` into
`/{prefix}/include`:
```meson
install_headers('common.h', 'proj/kola.h')
```
This will install `common.h` and `kola.h` into `/{prefix}/include/myproj`:
```meson
install_headers('common.h', 'proj/kola.h', subdir : 'myproj')
```
This will install `common.h` and `kola.h` into `/{prefix}/cust/myproj`:
```meson
install_headers('common.h', 'proj/kola.h', install_dir : 'cust', subdir : 'myproj')
```
Implement `preserve_path` for install_headers The `install_headers` function now has an optional argument `preserve_path` that allows installing multi-directory headerfile structures that live alongside sourcecode with a single command. For example, the headerfile structure headers = [ 'one.h', 'two.h', 'alpha/one.h', 'alpha/two.h', 'alpha/three.h' 'beta/one.h' ] can now be passed to `install_headers(headers, subdir: 'mylib', preserve_path: true)` and the resulting directory tree will look like {prefix} └── include    └── mylib       ├── alpha       │   ├── one.h       │   ├── two.h       │   └── three.h       ├── beta       │   └── one.h       ├── one.h       └── two.h Fixes #3371
3 years ago
This will install `common.h` into `/{prefix}/include` and `kola.h`
into `/{prefix}/include/proj/`:
```meson
install_headers('common.h, 'proj/kola.h', preserve_path : true)
```
docs: Add the YAML Reference manual
3 years ago
varargs:
name: file
type: file | str
description: Header files to install.
repair install_mode support for uid/gid effectively everywhere We silently dropped all integer values to install_mode since the original implementation of doing this in KwargInfo, in commit 596c8d4af50d0e5a25ee0ee1e177e46b6c7ad22e. This happened because install_mode is supposed to convert False (exactly) to None, and otherwise pass all arguments in place. But a generator is homogeneous and attempting to do this correctly produced a mypy error that FileMode arguments were allowed to be ints -- well of course they are -- so that resulted in the convertor... treating ints like False instead, to make mypy happy. Fixes #11538
2 years ago
warnings:
- the `install_mode` kwarg ignored integer values between 0.59.0 -- 1.1.0.
docs: Add the YAML Reference manual
3 years ago
kwargs:
install_dir:
type: str
document and raise an error for disallowed combination of install_headers args It makes no sense to specify both: - install_dir, which overrides the -Dincludedir= builtin option - subdir, which suffixes the -Dincludedir= builtin option We've always silently ignored the subdir in this case, which is really surprising if someone actually passed it and expected it to do something. We also confusingly didn't say anything in the documentation about it. Document that the options are incompatible, and explicitly check to see if they are both passed -- if so, raise an error message pointing out that only install_dir should be used. Fixes #10046
3 years ago
description: Where to install to.
docs: Add the YAML Reference manual
3 years ago
subdir:
type: str
document and raise an error for disallowed combination of install_headers args It makes no sense to specify both: - install_dir, which overrides the -Dincludedir= builtin option - subdir, which suffixes the -Dincludedir= builtin option We've always silently ignored the subdir in this case, which is really surprising if someone actually passed it and expected it to do something. We also confusingly didn't say anything in the documentation about it. Document that the options are incompatible, and explicitly check to see if they are both passed -- if so, raise an error message pointing out that only install_dir should be used. Fixes #10046
3 years ago
description: |
Install to the `subdir` subdirectory of the default includedir.
Incompatible with the `install_dir` kwarg.
docs: Add the YAML Reference manual
3 years ago
install_mode:
type: list[str | int]
since: 0.47.0
description: |
Specify the file mode in symbolic format
and optionally the owner/uid and group/gid for the installed files.
See the `install_mode` kwarg of [[install_data]] for more information.
Implement `preserve_path` for install_headers The `install_headers` function now has an optional argument `preserve_path` that allows installing multi-directory headerfile structures that live alongside sourcecode with a single command. For example, the headerfile structure headers = [ 'one.h', 'two.h', 'alpha/one.h', 'alpha/two.h', 'alpha/three.h' 'beta/one.h' ] can now be passed to `install_headers(headers, subdir: 'mylib', preserve_path: true)` and the resulting directory tree will look like {prefix} └── include    └── mylib       ├── alpha       │   ├── one.h       │   ├── two.h       │   └── three.h       ├── beta       │   └── one.h       ├── one.h       └── two.h Fixes #3371
3 years ago
preserve_path:
type: bool
since: 0.63.0
default: false
description: |
fix various spelling issues Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
2 years ago
Disable stripping child-directories from header files when installing.
Implement `preserve_path` for install_headers The `install_headers` function now has an optional argument `preserve_path` that allows installing multi-directory headerfile structures that live alongside sourcecode with a single command. For example, the headerfile structure headers = [ 'one.h', 'two.h', 'alpha/one.h', 'alpha/two.h', 'alpha/three.h' 'beta/one.h' ] can now be passed to `install_headers(headers, subdir: 'mylib', preserve_path: true)` and the resulting directory tree will look like {prefix} └── include    └── mylib       ├── alpha       │   ├── one.h       │   ├── two.h       │   └── three.h       ├── beta       │   └── one.h       ├── one.h       └── two.h Fixes #3371
3 years ago
This is equivalent to GNU Automake's `nobase` option.
install_{data,headers,subdir}: implement follow_symlinks This permits users who rely on following symlinks to stay on the old default of following them.
2 years ago
follow_symlinks:
type: bool
since: 1.3.0
default: true
description: |
If true, dereferences links and copies their target instead. The default
value will become false in the future.