diff options
| author | Xavier Claessens <xclaesse@gmail.com> | 2018-03-28 18:19:42 -0400 |
|---|---|---|
| committer | Jussi Pakkanen <jpakkane@gmail.com> | 2018-03-29 01:19:42 +0300 |
| commit | b4aee4675afd9f9f4a36aea628bab4249d7addbc (patch) | |
| tree | 9159f1d0c3ddf0b8db0780a8fb97c83e2a1f51a6 /docs | |
| parent | 9b2e533d87ad33c86b23869f2992c5882c8f6f6b (diff) | |
| download | meson-b4aee4675afd9f9f4a36aea628bab4249d7addbc.tar.gz | |
pkgconfig: Add a simple version of the generator (#3284)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/markdown/Pkgconfig-module.md | 7 | ||||
| -rw-r--r-- | docs/markdown/snippets/pkgconfig-generator.md | 14 |
2 files changed, 21 insertions, 0 deletions
diff --git a/docs/markdown/Pkgconfig-module.md b/docs/markdown/Pkgconfig-module.md index 853cf5064..77db809c9 100644 --- a/docs/markdown/Pkgconfig-module.md +++ b/docs/markdown/Pkgconfig-module.md @@ -51,3 +51,10 @@ keyword arguments. - `version` a string describing the version of this library - `d_module_versions` a list of module version flags used when compiling D sources referred to by this pkg-config file + +Since 0.46 a `StaticLibrary` or `SharedLibrary` object can optionally be passed +as first positional argument. If one is provided a default value will be +provided for all required fields of the pc file: +- `install_dir` is set to `pkgconfig` folder in the same location than the provided library. +- `description` is set to the project's name followed by the library's name. +- `name` is set to the library's name. diff --git a/docs/markdown/snippets/pkgconfig-generator.md b/docs/markdown/snippets/pkgconfig-generator.md new file mode 100644 index 000000000..93920d3bd --- /dev/null +++ b/docs/markdown/snippets/pkgconfig-generator.md @@ -0,0 +1,14 @@ +## Improvements to pkgconfig module + +A `StaticLibrary` or `SharedLibrary` object can optionally be passed +as first positional argument of the `generate()` method. If one is provided a +default value will be provided for all required fields of the pc file: +- `install_dir` is set to `pkgconfig` folder in the same location than the provided library. +- `description` is set to the project's name followed by the library's name. +- `name` is set to the library's name. + +Generating a .pc file is now as simple as: + +``` +pkgconfig.generate(mylib) +``` |