diff options
| author | Nirbheek Chauhan <nirbheek@centricular.com> | 2018-11-12 17:20:45 +0530 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-11-12 17:20:45 +0530 |
| commit | f831c05b553d876a08dcf46478161b60b4e693c4 (patch) | |
| tree | 27fd8cb4bd62ce0ffa8ffd6550ef839f979f2686 /docs | |
| parent | 0821462ce382541e120d8d6cfc1a3224a492b275 (diff) | |
| download | meson-f831c05b553d876a08dcf46478161b60b4e693c4.zip meson-f831c05b553d876a08dcf46478161b60b4e693c4.tar.gz meson-f831c05b553d876a08dcf46478161b60b4e693c4.tar.bz2 | |
docs: Clarify some pkgconfig module kwargs [skip ci]
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/markdown/Pkgconfig-module.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/markdown/Pkgconfig-module.md b/docs/markdown/Pkgconfig-module.md index b727f1a..9a34e14 100644 --- a/docs/markdown/Pkgconfig-module.md +++ b/docs/markdown/Pkgconfig-module.md @@ -14,7 +14,7 @@ can, of course, replace the name `pkg` with anything else. The generated file's properties are specified with the following keyword arguments. -- `description` a string describing the library +- `description` a string describing the library, used to set the `Description:` field - `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 @@ -33,7 +33,7 @@ keyword arguments. - `libraries_private` list of built libraries or strings to put in the `Libs.private` field. Since 0.45.0 it can also contain dependency objects, their `link_args` will be added to `Libs.private`. -- `name` the name of this library +- `name` the name of this library, used to set the `Name:` field - `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 @@ -48,7 +48,8 @@ keyword arguments. 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 +- `version` a string describing the version of this library, used to set the + `Version:` field. Defaults to the project version if unspecified. - `d_module_versions` a list of module version flags used when compiling D sources referred to by this pkg-config file |