mirror of
https://github.com/microsoft/vcpkg.git
synced 2024-12-25 19:27:50 +08:00
8cbc51f36b
Clarify that AUTO_CLEAN only removes the executables previously copied, not all of them.
37 lines
1.3 KiB
Markdown
37 lines
1.3 KiB
Markdown
# vcpkg_copy_tools
|
|
|
|
The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/vcpkg_copy_tools.md).
|
|
|
|
Copy tools and all their DLL dependencies into the `tools` folder.
|
|
|
|
## Usage
|
|
```cmake
|
|
vcpkg_copy_tools(
|
|
TOOL_NAMES <tool1>...
|
|
[SEARCH_DIR <${CURRENT_PACKAGES_DIR}/bin>]
|
|
[DESTINATION <${CURRENT_PACKAGES_DIR}/tools/${PORT}>]
|
|
[AUTO_CLEAN]
|
|
)
|
|
```
|
|
## Parameters
|
|
### TOOL_NAMES
|
|
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 omitted.
|
|
|
|
### DESTINATION
|
|
Destination to copy the tools to. This will be set to `${CURRENT_PACKAGES_DIR}/tools/${PORT}` if omitted.
|
|
|
|
### AUTO_CLEAN
|
|
Auto clean the copied executables from `${CURRENT_PACKAGES_DIR}/bin` and `${CURRENT_PACKAGES_DIR}/debug/bin`.
|
|
|
|
## Examples
|
|
|
|
* [cpuinfo](https://github.com/microsoft/vcpkg/blob/master/ports/cpuinfo/portfile.cmake)
|
|
* [nanomsg](https://github.com/microsoft/vcpkg/blob/master/ports/nanomsg/portfile.cmake)
|
|
* [uriparser](https://github.com/microsoft/vcpkg/blob/master/ports/uriparser/portfile.cmake)
|
|
|
|
## Source
|
|
[scripts/cmake/vcpkg\_copy\_tools.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_copy_tools.cmake)
|