vcpkg/docs/maintainers/vcpkg_extract_source_archive.md

1.3 KiB

vcpkg_extract_source_archive

Extract an archive into the source directory. Deprecated in favor of vcpkg_extract_source_archive_ex.

Usage

vcpkg_extract_source_archive(
    <${ARCHIVE}> [<${TARGET_DIRECTORY}>]
)

Parameters

ARCHIVE

The full path to the archive to be extracted.

This is usually obtained from calling vcpkg_download_distfile.

TARGET_DIRECTORY

If specified, the archive will be extracted into the target directory instead of ${CURRENT_BUILDTREES_DIR}/src/.

This can be used to mimic git submodules, by extracting into a subdirectory of another archive.

Notes

This command will also create a tracking file named .extracted in the TARGET_DIRECTORY. This file, when present, will suppress the extraction of the archive.

Examples

Source

scripts/cmake/vcpkg_extract_source_archive.cmake