diff options
| author | Vinny <vpaladino778@gmail.com> | 2019-10-01 11:21:04 -0400 |
|---|---|---|
| committer | Curtis J Bezault <curtbezault@gmail.com> | 2019-10-01 08:21:04 -0700 |
| commit | 5ebf65665dfbf29abeb49410070c2102490fd476 (patch) | |
| tree | 7b2d3a473ca111d319fee926aadc69ee8287701a /docs | |
| parent | 281d107328a2d08304a0a0c100ae69d9f3656e2c (diff) | |
| download | vcpkg-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 'docs')
| -rw-r--r-- | docs/maintainers/cmake_fixup_cmake_targets.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/maintainers/cmake_fixup_cmake_targets.md b/docs/maintainers/cmake_fixup_cmake_targets.md new file mode 100644 index 000000000..9bbaddbba --- /dev/null +++ b/docs/maintainers/cmake_fixup_cmake_targets.md @@ -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)
|