aboutsummaryrefslogtreecommitdiff
path: root/scripts
diff options
context:
space:
mode:
authorVinny <vpaladino778@gmail.com>2019-10-01 11:21:04 -0400
committerCurtis J Bezault <curtbezault@gmail.com>2019-10-01 08:21:04 -0700
commit5ebf65665dfbf29abeb49410070c2102490fd476 (patch)
tree7b2d3a473ca111d319fee926aadc69ee8287701a /scripts
parent281d107328a2d08304a0a0c100ae69d9f3656e2c (diff)
downloadvcpkg-5ebf65665dfbf29abeb49410070c2102490fd476.tar.gz
vcpkg-5ebf65665dfbf29abeb49410070c2102490fd476.zip
[Documentation] Added documentation page for vcpkg_fixup_cmake_targets.cmake (#8365)
* Added documentation page for vcpkg_fixup_cmake_targets.cmake, added example usage comment to .cmake file * Update cmake_fixup_cmake_targets.md * Update cmake_fixup_cmake_targets.md
Diffstat (limited to 'scripts')
-rw-r--r--scripts/cmake/vcpkg_fixup_cmake_targets.cmake14
1 files changed, 8 insertions, 6 deletions
diff --git a/scripts/cmake/vcpkg_fixup_cmake_targets.cmake b/scripts/cmake/vcpkg_fixup_cmake_targets.cmake
index 1e0f2493d..3b5370bcd 100644
--- a/scripts/cmake/vcpkg_fixup_cmake_targets.cmake
+++ b/scripts/cmake/vcpkg_fixup_cmake_targets.cmake
@@ -1,21 +1,23 @@
#.rst:
# .. command:: vcpkg_fixup_cmake_targets
#
-# Transform all /debug/share/<port>/*targets-debug.cmake files and move them to /share/<port>.
+# Transforms all /debug/share/<port>/*targets-debug.cmake files and move them to /share/<port>.
# Removes all /debug/share/<port>/*targets.cmake and /debug/share/<port>/*config.cmake
#
-# Transform all references matching /bin/*.exe to /tools/<port>/*.exe on Windows
-# Transform all references matching /bin/* to /tools/<port>/* on other platforms
+# Transforms all references matching /bin/*.exe to /tools/<port>/*.exe on Windows
+# Transforms all references matching /bin/* to /tools/<port>/* on other platforms
#
-# Fix ${_IMPORT_PREFIX} in auto generated targets to be one folder deeper.
-# Replace ${CURRENT_INSTALLED_DIR} with ${_IMPORT_PREFIX} in configs/targets.
+# Fixes ${_IMPORT_PREFIX} in auto generated targets to be one folder deeper.
+# Replaces ${CURRENT_INSTALLED_DIR} with ${_IMPORT_PREFIX} in configs/targets.
#
# ::
# vcpkg_fixup_cmake_targets([CONFIG_PATH <config_path>])
#
# ``CONFIG_PATH``
# *.cmake files subdirectory (like "lib/cmake/${PORT}").
-#
+#
+# Example usage:
+# vcpkg_fixup_cmake_targets(CONFIG_PATH "lib/cmake/myPort")
function(vcpkg_fixup_cmake_targets)
cmake_parse_arguments(_vfct "" "CONFIG_PATH;TARGET_PATH" "" ${ARGN})