parent
55dfe75fd7
commit
9b5a5c2e61
7 changed files with 98 additions and 34 deletions
@ -1,24 +1,42 @@ |
||||
# Pkgconfig module |
||||
|
||||
This module is a simple generator for [pkg-config](https://pkg-config.freedesktop.org/) files. |
||||
This module is a simple generator for |
||||
[pkg-config](https://pkg-config.freedesktop.org/) files. |
||||
|
||||
## Usage |
||||
|
||||
To use this module, just do: **`pkg = import('pkgconfig')`**. The following function will then be available as `pkg.generate()`. You can, of course, replace the name `pkg` with anything else. |
||||
To use this module, just do: **`pkg = import('pkgconfig')`**. The |
||||
following function will then be available as `pkg.generate()`. You |
||||
can, of course, replace the name `pkg` with anything else. |
||||
|
||||
### pkg.generate() |
||||
|
||||
The generated file's properties are specified with the following keyword arguments. |
||||
The generated file's properties are specified with the following |
||||
keyword arguments. |
||||
|
||||
- `libraries` a list of built libraries (usually results of shared_library) that the user needs to link against |
||||
- `version` a string describing the version of this library |
||||
- `name` the name of this library |
||||
- `description` a string describing the library |
||||
- `filebase`, the base name to use for the pkg-config file, as an example the value of `libfoo` would produce a pkg-config file called `libfoo.pc` |
||||
- `subdirs` which subdirs of `include` should be added to the header search path, for example if you install headers into `${PREFIX}/include/foobar-1`, the correct value for this argument would be `foobar-1` |
||||
- `extra_cflags` a list of extra compiler flags to be added to the |
||||
`Cflags` field after the header search path |
||||
- `filebase`, the base name to use for the pkg-config file, as an |
||||
example the value of `libfoo` would produce a pkg-config file called |
||||
`libfoo.pc` |
||||
- `install_dir` the directory to install to, defaults to the value of |
||||
option `libdir` followed by `/pkgconfig` |
||||
- `libraries` a list of built libraries (usually results of |
||||
shared_library) that the user needs to link against |
||||
- `libraries_private` list of strings to put in the |
||||
`Libraries.private` field |
||||
- `name` the name of this library |
||||
- `subdirs` which subdirs of `include` should be added to the header |
||||
search path, for example if you install headers into |
||||
`${PREFIX}/include/foobar-1`, the correct value for this argument |
||||
would be `foobar-1` |
||||
- `requires` list of strings to put in the `Requires` field |
||||
- `requires_private` list of strings to put in the `Requires.private` field |
||||
- `libraries_private` list of strings to put in the `Libraries.private` field |
||||
- `install_dir` the directory to install to, defaults to the value of option `libdir` followed by `/pkgconfig` |
||||
- `extra_cflags` a list of extra compiler flags to be added to the `Cflags` field after the header search path |
||||
- `variables` a list of strings with custom variables to add to the generated file. The strings must be in the form `name=value` and may reference other pkgconfig variables, e.g. `datadir=${prefix}/share`. The names `prefix`, `libdir` and `installdir` are reserved and may not be used. |
||||
- `requires_private` list of strings to put in the `Requires.private` |
||||
field |
||||
- `variables` a list of strings with custom variables to add to the |
||||
generated file. The strings must be in the form `name=value` and may |
||||
reference other pkgconfig variables, |
||||
e.g. `datadir=${prefix}/share`. The names `prefix`, `libdir` and |
||||
`installdir` are reserved and may not be used. |
||||
- `version` a string describing the version of this library |
||||
|
@ -1,3 +1,4 @@ |
||||
# Qt4 module |
||||
|
||||
This module provides support for Qt4's `moc`, `uic` and `rcc` tools. It is used identically to the [Qt 5 module](Qt5-module.md). |
||||
This module provides support for Qt4's `moc`, `uic` and `rcc` |
||||
tools. It is used identically to the [Qt 5 module](Qt5-module.md). |
||||
|
@ -1,10 +1,16 @@ |
||||
# RPM module |
||||
|
||||
The RPM module can be used to create a sample rpm spec file for a Meson project. It autodetects installed files, dependencies and so on. Using it is very simple. At the very end of your Meson project (that is, the end of your top level `meson.build` file) add these two lines. |
||||
The RPM module can be used to create a sample rpm spec file for a |
||||
Meson project. It autodetects installed files, dependencies and so |
||||
on. Using it is very simple. At the very end of your Meson project |
||||
(that is, the end of your top level `meson.build` file) add these two |
||||
lines. |
||||
|
||||
```meson |
||||
rpm = import('rpm') |
||||
rpm.generate_spec_template() |
||||
``` |
||||
|
||||
Run Meson once on your code and the template will be written in your build directory. Then remove the two lines above and manually edit the template to add missing information. After this it is ready for use. |
||||
Run Meson once on your code and the template will be written in your |
||||
build directory. Then remove the two lines above and manually edit the |
||||
template to add missing information. After this it is ready for use. |
||||
|
@ -1,12 +1,17 @@ |
||||
# Windows module |
||||
|
||||
This module provides functionality used to build applications for Windows. |
||||
This module provides functionality used to build applications for |
||||
Windows. |
||||
|
||||
## Methods |
||||
|
||||
### compile_resources |
||||
|
||||
Compiles Windows `rc` files specified in the positional arguments. Returns an opaque object that you put in the list of sources for the target you want to have the resources in. This method has the following keyword argument. |
||||
Compiles Windows `rc` files specified in the positional |
||||
arguments. Returns an opaque object that you put in the list of |
||||
sources for the target you want to have the resources in. This method |
||||
has the following keyword argument. |
||||
|
||||
- `args` lists extra arguments to pass to the resource compiler |
||||
- `include_directories` which does the same thing as it does on target declarations: specifies header search directories |
||||
- `include_directories` which does the same thing as it does on target |
||||
declarations: specifies header search directories |
||||
|
Loading…
Reference in new issue