aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAlexander Neumann <30894796+Neumann-A@users.noreply.github.com>2021-03-31 21:47:35 +0200
committerGitHub <noreply@github.com>2021-03-31 12:47:35 -0700
commit2779b733c221361aa33290f2dce1dd2cc5a0cbf1 (patch)
tree9742ed865c74f365feb2b553a2d101538c924930 /docs
parent93304d198183634d07ea97aa831480a79f6960d6 (diff)
downloadvcpkg-2779b733c221361aa33290f2dce1dd2cc5a0cbf1.tar.gz
vcpkg-2779b733c221361aa33290f2dce1dd2cc5a0cbf1.zip
[vcpkg/scripts] add a way to define another tool destination (#16935)
Diffstat (limited to 'docs')
-rw-r--r--docs/maintainers/vcpkg_copy_tools.md4
-rw-r--r--docs/maintainers/vcpkg_fixup_cmake_targets.md12
2 files changed, 13 insertions, 3 deletions
diff --git a/docs/maintainers/vcpkg_copy_tools.md b/docs/maintainers/vcpkg_copy_tools.md
index 34a4bb84a..98e86e05b 100644
--- a/docs/maintainers/vcpkg_copy_tools.md
+++ b/docs/maintainers/vcpkg_copy_tools.md
@@ -9,6 +9,7 @@ Copy tools and all their DLL dependencies into the `tools` folder.
vcpkg_copy_tools(
TOOL_NAMES <tool1>...
[SEARCH_DIR <${CURRENT_PACKAGES_DIR}/bin>]
+ [DESTINATION <${CURRENT_PACKAGES_DIR}/tools/${PORT}>]
[AUTO_CLEAN]
)
```
@@ -19,6 +20,9 @@ A list of tool filenames without extension.
### SEARCH_DIR
The path to the directory containing the tools. This will be set to `${CURRENT_PACKAGES_DIR}/bin` if ommited.
+### DESTINATION
+Destination to copy the tools to. This will be set to `${CURRENT_PACKAGES_DIR}/tools/${PORT}` if ommited.
+
### AUTO_CLEAN
Auto clean executables in `${CURRENT_PACKAGES_DIR}/bin` and `${CURRENT_PACKAGES_DIR}/debug/bin`.
diff --git a/docs/maintainers/vcpkg_fixup_cmake_targets.md b/docs/maintainers/vcpkg_fixup_cmake_targets.md
index dbb6fb432..704ac4ad1 100644
--- a/docs/maintainers/vcpkg_fixup_cmake_targets.md
+++ b/docs/maintainers/vcpkg_fixup_cmake_targets.md
@@ -10,7 +10,10 @@ Additionally corrects common issues with targets, such as absolute paths and inc
## Usage
```cmake
-vcpkg_fixup_cmake_targets([CONFIG_PATH <share/${PORT}>] [TARGET_PATH <share/${PORT}>] [DO_NOT_DELETE_PARENT_CONFIG_PATH])
+vcpkg_fixup_cmake_targets([CONFIG_PATH <share/${PORT}>]
+ [TARGET_PATH <share/${PORT}>]
+ [TOOLS_PATH <tools/${PORT}>]
+ [DO_NOT_DELETE_PARENT_CONFIG_PATH])
```
## Parameters
@@ -36,12 +39,15 @@ Disables the correction of_IMPORT_PREFIX done by vcpkg due to moving the targets
Currently the correction does not take into account how the files are moved and applies
I rather simply correction which in some cases will yield the wrong results.
+### TOOLS_PATH
+Define the base path to tools. Default: `tools/<PORT>`
+
## Notes
Transform all `/debug/<CONFIG_PATH>/*targets-debug.cmake` files and move them to `/<TARGET_PATH>`.
Removes all `/debug/<CONFIG_PATH>/*targets.cmake` and `/debug/<CONFIG_PATH>/*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.
+Transform all references matching `/bin/*.exe` to `/${TOOLS_PATH}/*.exe` on Windows.
+Transform all references matching `/bin/*` to `/${TOOLS_PATH}/*` on other platforms.
Fix `${_IMPORT_PREFIX}` in auto generated targets to be one folder deeper.
Replace `${CURRENT_INSTALLED_DIR}` with `${_IMPORT_PREFIX}` in configs and targets.