[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
This commit is contained in:
Vinny 2019-10-01 11:21:04 -04:00 committed by Curtis J Bezault
parent 281d107328
commit 5ebf65665d
2 changed files with 33 additions and 6 deletions

View File

@ -0,0 +1,25 @@
# vcpkg_fixup_cmake_targets
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.
Transforms all references matching /bin/\*.exe tools/\<port\>/\*.exe on Windows.
Transforms all references matching /bin/\* to /tools/\<port\>/\* on other platforms.
Fixups ${_IMPORT_PREFIX} in auto generated targets to be one folder deeper.
Replaces ${CURRENT_INSTALLED_DIR} with ${_IMPORT_PREFIX} in config files and targets.
## Usage
```cmake
vcpkg_fixup_cmake_targets(CONFIG_PATH <config_path>)
```
## Parameters:
### CONFIG_PATH
*.cmake files subdirectory (e.g. "lib/cmake/${PORT}" or "cmake/${PORT}).
### TARGET_PATH
Optional location to place fixup'd files. Unecessary if target is "share/${PORT}".
## Source
[scripts/cmake/cmake_fixup_cmake_targets.cmake](https://github.com/microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_fixup_cmake_targets.cmake)

View File

@ -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})