vcpkg/docs/maintainers/vcpkg_extract_source_archive.md
nicole mazzuca 3426db05b9
[scripts-audit] Rollup PR 2021-02-26 ()
* [scripts-audit rollup] PR 

* pull the cmake doc comment parsing out into its own function
* support cmake helper ports
* add real support for deprecation, as opposed to ad-hoc

* [scripts-audit rollup] PR 

* add a z_ in front of internal functions
* move internal functions out

set feature_vars again in parent scope

* [scripts-audit rollup] PR 

Audit vcpkg_copy_pdbs

* [scripts-audit rollup] PR 

* Fix usage, documentation

* [scripts-audit rollup] PR 

* [scripts-audit rollup] PR 

Deprecate `vcpkg_*_cmake` in favor of `vcpkg_cmake_*` from the
`vcpkg-cmake` port, as well as `vcpkg_fixup_cmake_targets`
in favor of `vcpkg_cmake_config_fixup` from the
`vcpkg-cmake-config` port.
2021-02-28 13:17:19 -08:00

1.4 KiB

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