[doc] document vcpkg_fixup_pkgconfig merging behaviour (#18091)

* [doc] document vcpkg_fixup_pkgconfig merging behaviour * [doc] add source
microsoft · Jun 4, 2021 · bec883f · bec883f
1 parent 750c0bd
commit bec883f
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/docs/maintainers/vcpkg_fixup_pkgconfig.md b/docs/maintainers/vcpkg_fixup_pkgconfig.md
@@ -2,7 +2,11 @@
 
 The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/vcpkg_fixup_pkgconfig.md).
 
-Fix common paths in *.pc files and make everything relative to $(prefix)
+Fix common paths in *.pc files and make everything relative to $(prefix).
+Additionally, on static triplets, private entries are merged with their non-private counterparts,
+allowing pkg-config to be called without the ``--static`` flag.
+Note that vcpkg is designed to never have to call pkg-config with the ``--static`` flag,
+since a consumer cannot know if a dependent library has been built statically or not.
 
 ## Usage
 ```cmake

diff --git a/scripts/cmake/vcpkg_fixup_pkgconfig.cmake b/scripts/cmake/vcpkg_fixup_pkgconfig.cmake
@@ -1,7 +1,11 @@
 #[===[.md:
 # vcpkg_fixup_pkgconfig
 
-Fix common paths in *.pc files and make everything relative to $(prefix)
+Fix common paths in *.pc files and make everything relative to $(prefix).
+Additionally, on static triplets, private entries are merged with their non-private counterparts,
+allowing pkg-config to be called without the ``--static`` flag.
+Note that vcpkg is designed to never have to call pkg-config with the ``--static`` flag,
+since a consumer cannot know if a dependent library has been built statically or not.
 
 ## Usage
 ```cmake