vcpkg/docs/maintainers/vcpkg_copy_tools.md
Dawid Wróbel 8cbc51f36b
[Docs] vcpkg_copy_tools cleans only copied tools (#20940)
Clarify that AUTO_CLEAN only removes the executables previously copied, not all of them.
2021-10-26 23:44:43 -07:00

1.3 KiB

vcpkg_copy_tools

The latest version of this document lives in the vcpkg repo.

Copy tools and all their DLL dependencies into the tools folder.

Usage

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

Source

scripts/cmake/vcpkg_copy_tools.cmake