vcpkg/docs/maintainers/vcpkg_extract_source_archive.md

# 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)
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-25 14:33:16 +08:00			`# vcpkg_extract_source_archive`

[vcpkg_extract_source_archive_ex] Document vcpkg_extract_source_archive_ex 2018-11-23 06:48:18 +08:00			Extract an archive into the source directory. Deprecated in favor of [`vcpkg_extract_source_archive_ex`](vcpkg_extract_source_archive_ex.md).
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-25 14:33:16 +08:00
			`## 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`
[vcpkg docs] Check for documentation generation in CI (#14614) * [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 2020-12-02 05:37:26 +08:00			If specified, the archive will be extracted into the target directory instead of `${CURRENT_BUILDTREES_DIR}/src/`.
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-25 14:33:16 +08:00
			`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`
[vcpkg docs] consistency-ify docs/regenerate on non-windows (#16127) 2021-02-09 05:55:11 +08:00			`[scripts/cmake/vcpkg_extract_source_archive.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_extract_source_archive.cmake)`