mirror of
https://github.com/microsoft/vcpkg.git
synced 2024-12-23 07:30:26 +08:00
3426db05b9
* [scripts-audit rollup] PR #16419 * 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 #16192 * add a z_ in front of internal functions * move internal functions out set feature_vars again in parent scope * [scripts-audit rollup] PR #16309 Audit vcpkg_copy_pdbs * [scripts-audit rollup] PR #16304 * Fix usage, documentation * [scripts-audit rollup] PR #16393 * [scripts-audit rollup] PR #16377 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.
35 lines
1.4 KiB
Markdown
35 lines
1.4 KiB
Markdown
# vcpkg_extract_source_archive
|
|
|
|
The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/maintainers/vcpkg_extract_source_archive.md).
|
|
|
|
Extract an archive into the source directory. Deprecated in favor of [`vcpkg_extract_source_archive_ex`](vcpkg_extract_source_archive_ex.md).
|
|
|
|
## Usage
|
|
```cmake
|
|
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`](vcpkg_download_distfile.md).
|
|
|
|
### 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 <FILENAME>.extracted in the TARGET_DIRECTORY. This file, when present, will suppress the extraction of the archive.
|
|
|
|
## Examples
|
|
|
|
* [libraw](https://github.com/Microsoft/vcpkg/blob/master/ports/libraw/portfile.cmake)
|
|
* [protobuf](https://github.com/Microsoft/vcpkg/blob/master/ports/protobuf/portfile.cmake)
|
|
* [msgpack](https://github.com/Microsoft/vcpkg/blob/master/ports/msgpack/portfile.cmake)
|
|
|
|
## Source
|
|
[scripts/cmake/vcpkg\_extract\_source\_archive.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_extract_source_archive.cmake)
|