mirror of
https://github.com/microsoft/vcpkg.git
synced 2024-11-28 04:19:00 +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
55 lines
1.9 KiB
CMake
55 lines
1.9 KiB
CMake
#[===[.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)
|
|
#]===]
|
|
|
|
include(vcpkg_execute_required_process)
|
|
|
|
function(vcpkg_extract_source_archive ARCHIVE)
|
|
if(NOT ARGC EQUAL 2)
|
|
set(WORKING_DIRECTORY "${CURRENT_BUILDTREES_DIR}/src")
|
|
else()
|
|
set(WORKING_DIRECTORY ${ARGV1})
|
|
endif()
|
|
|
|
get_filename_component(ARCHIVE_FILENAME "${ARCHIVE}" NAME)
|
|
if(NOT EXISTS ${WORKING_DIRECTORY}/${ARCHIVE_FILENAME}.extracted)
|
|
message(STATUS "Extracting source ${ARCHIVE}")
|
|
file(MAKE_DIRECTORY ${WORKING_DIRECTORY})
|
|
vcpkg_execute_required_process(
|
|
ALLOW_IN_DOWNLOAD_MODE
|
|
COMMAND ${CMAKE_COMMAND} -E tar xjf ${ARCHIVE}
|
|
WORKING_DIRECTORY ${WORKING_DIRECTORY}
|
|
LOGNAME extract
|
|
)
|
|
file(WRITE ${WORKING_DIRECTORY}/${ARCHIVE_FILENAME}.extracted)
|
|
endif()
|
|
endfunction()
|