aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown
diff options
context:
space:
mode:
authorXavier Claessens <xclaesse@gmail.com>2018-03-28 18:19:42 -0400
committerJussi Pakkanen <jpakkane@gmail.com>2018-03-29 01:19:42 +0300
commitb4aee4675afd9f9f4a36aea628bab4249d7addbc (patch)
tree9159f1d0c3ddf0b8db0780a8fb97c83e2a1f51a6 /docs/markdown
parent9b2e533d87ad33c86b23869f2992c5882c8f6f6b (diff)
downloadmeson-b4aee4675afd9f9f4a36aea628bab4249d7addbc.zip
meson-b4aee4675afd9f9f4a36aea628bab4249d7addbc.tar.gz
meson-b4aee4675afd9f9f4a36aea628bab4249d7addbc.tar.bz2
pkgconfig: Add a simple version of the generator (#3284)
Diffstat (limited to 'docs/markdown')
-rw-r--r--docs/markdown/Pkgconfig-module.md7
-rw-r--r--docs/markdown/snippets/pkgconfig-generator.md14
2 files changed, 21 insertions, 0 deletions
diff --git a/docs/markdown/Pkgconfig-module.md b/docs/markdown/Pkgconfig-module.md
index 853cf50..77db809 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 0000000..93920d3
--- /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)
+```