mirror of
https://github.com/microsoft/vcpkg.git
synced 2024-12-04 23:39:02 +08:00
6b117c9c7e
* [vcpkg docs] Change how documenting port functions works Instead of using `##`, use comment blocks for documentation. Also, add some minor docs and change RST -> MD so we actually get docs generated. * add CI stuff * regenerate docs * fix vcpkg_find_acquire_program to not use _execute_process
33 lines
1.3 KiB
Markdown
33 lines
1.3 KiB
Markdown
# vcpkg_extract_source_archive
|
|
|
|
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)
|