diff options
author | Fredrik Salomonsson <plattfot@posteo.net> | 2022-04-13 14:28:59 -0700 |
---|---|---|
committer | Eli Schwartz <eschwartz93@gmail.com> | 2022-04-19 17:35:08 -0400 |
commit | 442fd7dc73dcdd86212f833aa342e9d6d98fba32 (patch) | |
tree | 41ec8f5fab1551960b8470b7480869c5bba1e6bd /docs/markdown/snippets | |
parent | ef0c38f90ab8f55ccb319c184523a326ca975f39 (diff) | |
download | meson-442fd7dc73dcdd86212f833aa342e9d6d98fba32.zip meson-442fd7dc73dcdd86212f833aa342e9d6d98fba32.tar.gz meson-442fd7dc73dcdd86212f833aa342e9d6d98fba32.tar.bz2 |
docs: Add documentation on pkgconfig.relocatable
- Documentation for the pkgconfig.relocatable module option in
Builtin-options. Gives an explanation on what it does, usefulness and
what error that can occur when using it.
- Add pkgconfig.relocatable release snippet. Similar to the
documentation in Builtin-options. Just a bit more brief.
- Add Pkgconfig to DataTests.test_builtin_options_documented in the
docs unit tests.
Diffstat (limited to 'docs/markdown/snippets')
-rw-r--r-- | docs/markdown/snippets/pkgconfig-relocatable.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/markdown/snippets/pkgconfig-relocatable.md b/docs/markdown/snippets/pkgconfig-relocatable.md new file mode 100644 index 0000000..901da6e --- /dev/null +++ b/docs/markdown/snippets/pkgconfig-relocatable.md @@ -0,0 +1,18 @@ +## Installed pkgconfig files can now be relocatable + +The pkgconfig module now has a module option `pkgconfig.relocatable`. +When set to `true`, the pkgconfig files generated will have their +`prefix` variable set to be relative to their `install_dir`. + +For example to enable it from the command line run: + +```sh +meson setup builddir -Dpkgconfig.relocatable=true … +``` + +It will only work if the `install_dir` for the generated pkgconfig +files are located inside the install prefix of the package. Not doing +so will cause an error. + +This should be useful on Windows or any other platform where +relocatable packages are desired. |