aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAlexander Neumann <30894796+Neumann-A@users.noreply.github.com>2021-04-06 19:53:41 +0200
committerGitHub <noreply@github.com>2021-04-06 10:53:41 -0700
commit1bb0fe61dfecd1450a1ff44c7fc8d424365366aa (patch)
tree7e99db8c737c022a6e19392ec0a6f98504a38069 /docs
parent030cfaa24de9ea1bbf0a4d9c615ce7312ba77af1 (diff)
downloadvcpkg-1bb0fe61dfecd1450a1ff44c7fc8d424365366aa.tar.gz
vcpkg-1bb0fe61dfecd1450a1ff44c7fc8d424365366aa.zip
[vcpkg baseline][qt5-base] Fix glib link issues on linux (#16954)
* [qt5-base] fix glib link issues on linux * add version * remove unused vars * update version * write port info file. * version stuff * remove paraview from baseline. It was added due to the same spurious glib failures. * trying out a different approach * more changes * change the if to actually use the buildtype instead * remove x_vcpkg_get_port_info * add option QT_OPENSSL_LINK back in * use INCLUDE_DIRS_(DEBUG|RELEASE) instead of just INCLUDE_DIRS * regen docs * remove function call I forgot to remove * [vcpkg-pkgconfig-get-modules] Move to port * revert changes to ports.cmake * include the file in qt5-base * fix path * remove unnecessary include * Apply suggestions from code review Co-authored-by: nicole mazzuca <mazzucan@outlook.com> * Apply suggestions from code review * update version * ws removal * version stuff Co-authored-by: Robert Schumacher <roschuma@microsoft.com> Co-authored-by: nicole mazzuca <mazzucan@outlook.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/maintainers/portfile-functions.md4
-rw-r--r--docs/maintainers/ports/vcpkg-pkgconfig-get-modules.md6
-rw-r--r--docs/maintainers/ports/vcpkg-pkgconfig-get-modules/x_vcpkg_pkgconfig_get_modules.md44
-rwxr-xr-xdocs/regenerate.ps11
4 files changed, 55 insertions, 0 deletions
diff --git a/docs/maintainers/portfile-functions.md b/docs/maintainers/portfile-functions.md
index fbad18c8e..842ef6137 100644
--- a/docs/maintainers/portfile-functions.md
+++ b/docs/maintainers/portfile-functions.md
@@ -73,3 +73,7 @@
### [vcpkg-cmake-config](ports/vcpkg-cmake-config.md)
- [vcpkg\_cmake\_config\_fixup](ports/vcpkg-cmake-config/vcpkg_cmake_config_fixup.md)
+
+### [vcpkg-pkgconfig-get-modules](ports/vcpkg-pkgconfig-get-modules.md)
+
+- [x\_vcpkg\_pkgconfig\_get\_modules](ports/vcpkg-pkgconfig-get-modules/x_vcpkg_pkgconfig_get_modules.md)
diff --git a/docs/maintainers/ports/vcpkg-pkgconfig-get-modules.md b/docs/maintainers/ports/vcpkg-pkgconfig-get-modules.md
new file mode 100644
index 000000000..ac99412c2
--- /dev/null
+++ b/docs/maintainers/ports/vcpkg-pkgconfig-get-modules.md
@@ -0,0 +1,6 @@
+# vcpkg-pkgconfig-get-modules
+
+**Experimental: will change or be removed at any time**
+
+`vcpkg-pkgconfig-get-modules` provides `x_vcpkg_pkgconfig_get_modules()`, a function which simplifies calling
+`pkg-config` in portfiles in order to gather dependencies for exotic buildsystems.
diff --git a/docs/maintainers/ports/vcpkg-pkgconfig-get-modules/x_vcpkg_pkgconfig_get_modules.md b/docs/maintainers/ports/vcpkg-pkgconfig-get-modules/x_vcpkg_pkgconfig_get_modules.md
new file mode 100644
index 000000000..06299533a
--- /dev/null
+++ b/docs/maintainers/ports/vcpkg-pkgconfig-get-modules/x_vcpkg_pkgconfig_get_modules.md
@@ -0,0 +1,44 @@
+# x_vcpkg_pkgconfig_get_modules
+
+The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/ports/vcpkg-pkgconfig-get-modules/x_vcpkg_pkgconfig_get_modules.md).
+
+Experimental
+Retrieve required module information from pkgconfig modules
+
+## Usage
+```cmake
+x_vcpkg_pkgconfig_get_modules(
+ PREFIX <prefix>
+ MODULES <pkgconfig_modules>...
+ [LIBS]
+ [LIBRARIES]
+ [LIBRARIES_DIRS]
+ [INCLUDE_DIRS]
+)
+```
+## Parameters
+
+### PREFIX
+Used variable prefix to use
+
+### MODULES
+List of pkgconfig modules to retrieve information for.
+
+### LIBS
+Returns `"${PKGCONFIG}" --libs` in <prefix>_LIBS_(DEBUG|RELEASE)
+
+### LIBRARIES
+Returns `"${PKGCONFIG}" --libs-only-l` in <prefix>_LIBRARIES_(DEBUG|RELEASE)
+
+### LIBRARIES_DIRS
+Returns `"${PKGCONFIG}" --libs-only-L` in <prefix>_LIBRARIES_DIRS_(DEBUG|RELEASE)
+
+### INCLUDE_DIRS
+Returns `"${PKGCONFIG}" --cflags-only-I` in <prefix>_INCLUDE_DIRS_(DEBUG|RELEASE)
+
+## Examples
+
+* [qt5-base](https://github.com/microsoft/vcpkg/blob/master/ports/qt5-base/portfile.cmake)
+
+## Source
+[ports/vcpkg-pkgconfig-get-modules/x\_vcpkg\_pkgconfig\_get\_modules.cmake](https://github.com/Microsoft/vcpkg/blob/master/ports/vcpkg-pkgconfig-get-modules/x_vcpkg_pkgconfig_get_modules.cmake)
diff --git a/docs/regenerate.ps1 b/docs/regenerate.ps1
index 93e78a3c9..4c847f75a 100755
--- a/docs/regenerate.ps1
+++ b/docs/regenerate.ps1
@@ -26,6 +26,7 @@ class CMakeDocumentation {
[String[]]$cmakeScriptsPorts = @(
'vcpkg-cmake'
'vcpkg-cmake-config'
+ 'vcpkg-pkgconfig-get-modules'
)
[CMakeDocumentation[]]$tableOfContents = @()