From 2377f22ea594ee10c98e90df438d437362cca5ea Mon Sep 17 00:00:00 2001 From: Aleksey Filippov Date: Sat, 24 Feb 2018 22:41:34 +0000 Subject: [PATCH] Document pkgconfig.generate() requires parameters --- docs/markdown/Pkgconfig-module.md | 5 +++-- docs/markdown/snippets/pkgconfig-requires-non-string.md | 5 +++++ 2 files changed, 8 insertions(+), 2 deletions(-) create mode 100644 docs/markdown/snippets/pkgconfig-requires-non-string.md diff --git a/docs/markdown/Pkgconfig-module.md b/docs/markdown/Pkgconfig-module.md index cbe01b4e0..853cf5064 100644 --- a/docs/markdown/Pkgconfig-module.md +++ b/docs/markdown/Pkgconfig-module.md @@ -38,8 +38,9 @@ keyword arguments. 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` +- `requires` list of strings, pkgconfig-dependencies or libraries that + `pkgconfig.generate()` was used on to put in the `Requires` field +- `requires_private` same as `requires` but for `Requires.private` field field - `url` a string with a url for the library - `variables` a list of strings with custom variables to add to the diff --git a/docs/markdown/snippets/pkgconfig-requires-non-string.md b/docs/markdown/snippets/pkgconfig-requires-non-string.md new file mode 100644 index 000000000..fc848a813 --- /dev/null +++ b/docs/markdown/snippets/pkgconfig-requires-non-string.md @@ -0,0 +1,5 @@ +# pkgconfig.generate() requires parameters non-string arguments + +`pkgconfig.generate()` `requires` and `requires_private` parameters +accept pkgconfig-dependencies and libraries that pkgconfig-files were +generated for.