aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authornicole mazzuca <mazzucan@outlook.com>2021-09-27 13:27:44 -0700
committerGitHub <noreply@github.com>2021-09-27 13:27:44 -0700
commitf0281bf749f6b7c39418b57a60ae91c5f5d65b0f (patch)
treea29ac8106181d0e4fce93a268a4e100742ff9273 /docs
parent46700e2a0c6a4e7d93d40da00965d01925b48ef5 (diff)
downloadvcpkg-f0281bf749f6b7c39418b57a60ae91c5f5d65b0f.tar.gz
vcpkg-f0281bf749f6b7c39418b57a60ae91c5f5d65b0f.zip
[scripts-audit] vcpkg_fixup_pkgconfig (#19658)
* [scripts-audit] vcpkg_fixup_pkgconfig * Neumann-A CR, fix docs * vcpkg_fixup_pkgconfig bugs * fix group * moar fixing * be more clever around pkg_config_path * add `vcpkg_host_path_list` so that we can unit test * move stuff around a bit * fix bug in vcpkg_host_path_list.cmake * ras0219 CRs
Diffstat (limited to 'docs')
-rw-r--r--docs/maintainers/portfile-functions.md1
-rw-r--r--docs/maintainers/vcpkg_host_path_list.md26
2 files changed, 27 insertions, 0 deletions
diff --git a/docs/maintainers/portfile-functions.md b/docs/maintainers/portfile-functions.md
index 45aa4589b..6527d8e0b 100644
--- a/docs/maintainers/portfile-functions.md
+++ b/docs/maintainers/portfile-functions.md
@@ -44,6 +44,7 @@
- [vcpkg\_from\_sourceforge](vcpkg_from_sourceforge.md)
- [vcpkg\_get\_program\_files\_platform\_bitness](vcpkg_get_program_files_platform_bitness.md)
- [vcpkg\_get\_windows\_sdk](vcpkg_get_windows_sdk.md)
+- [vcpkg\_host\_path\_list](vcpkg_host_path_list.md)
- [vcpkg\_install\_cmake](vcpkg_install_cmake.md) (deprecated, use [vcpkg\_cmake\_install](ports/vcpkg-cmake/vcpkg_cmake_install.md))
- [vcpkg\_install\_gn](vcpkg_install_gn.md)
- [vcpkg\_install\_make](vcpkg_install_make.md)
diff --git a/docs/maintainers/vcpkg_host_path_list.md b/docs/maintainers/vcpkg_host_path_list.md
new file mode 100644
index 000000000..8517e7f56
--- /dev/null
+++ b/docs/maintainers/vcpkg_host_path_list.md
@@ -0,0 +1,26 @@
+# vcpkg_host_path_list
+
+The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/vcpkg_host_path_list.md).
+
+Modify a host path list variable (PATH, INCLUDE, LIBPATH, etc.)
+
+```cmake
+vcpkg_host_path_list(PREPEND <list-var> [<path>...])
+vcpkg_host_path_list(APPEND <list-var> [<path>...])
+```
+
+`<list-var>` may be either a regular variable name, or `ENV{variable-name}`,
+in which case `vcpkg_host_path_list` will modify the environment.
+
+`vcpkg_host_path_list` adds all of the paths passed to it to `<list-var>`;
+`PREPEND` puts them before the existing list, so that they are searched first;
+`APPEND` places them after the existing list,
+so they would be searched after the paths which are already in the variable.
+
+For both `APPEND` and `PREPEND`,
+the paths are added (and thus searched) in the order received.
+
+If no paths are passed, then nothing will be done.
+
+## Source
+[scripts/cmake/vcpkg\_host\_path\_list.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_host_path_list.cmake)