mirror/vcpkg
1
0
Fork 0
mirror of https://github.com/microsoft/vcpkg.git synced 2024-12-05 09:09:08 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
7f17087407
vcpkg/docs/maintainers/vcpkg_extract_source_archive.md
Jack·Boos·Yu 2b20b27b0d
[docs] Fix the automatically generated document URL (#16611) 
* [document] Fix the automatically generated document URL

* [docs] Format all documents
2021-03-10 11:56:07 -06:00

1.4 KiB
Raw Blame History

vcpkg_extract_source_archive

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

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