mirror of
https://github.com/microsoft/vcpkg.git
synced 2024-12-25 20:37:50 +08:00
d369df7ecf
* [rollup:2021-07-06 1/8] PR #18272 (@strega-nil) [scripts-audit] vcpkg_from_* * [rollup:2021-07-06 2/8] PR #18319 (@strega-nil) [scripts-audit] add guidelines for cmake * [rollup 2021-07-06 3/8] PR #18410 (@mheyman) [vcpkg-cmake-config] documentation fix * [rollup:2021-07-06 4/8] PR #18488 (@strega-nil) [scripts-audit] vcpkg_execute_* * [rollup:2021-07-06 5/8] PR #18517 (@strega-nil) [scripts-audit] vcpkg_extract_source_archive * [rollup:2021-07-06 6/8] PR #18674 (@NancyLi1013) [vcpkg doc] Update examples * [rollup:2021-07-06 7/8] PR #18695 (@JackBoosY) [vcpkg] Update the minimum version of vcpkg * [rollup:2021-07-06 8/8] PR #18758 (@ras0219-msft) [vcpkg_from_git] Fix error if downloads folder does not exist * build docs! * fix bond:*-windows * fix nmap Co-authored-by: nicole mazzuca <mazzucan@outlook.com> Co-authored-by: Michael Heyman <Michael.Heyman@jhuapl.edu> Co-authored-by: NancyLi1013 <lirui09@beyondsoft.com> Co-authored-by: JackBoosY <yuzaiyang@beyondsoft.com> Co-authored-by: Robert Schumacher <ras0219@outlook.com>
49 lines
1.2 KiB
Markdown
49 lines
1.2 KiB
Markdown
# vcpkg_from_git
|
|
|
|
The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/vcpkg_from_git.md).
|
|
|
|
Download and extract a project from git
|
|
|
|
## Usage:
|
|
```cmake
|
|
vcpkg_from_git(
|
|
OUT_SOURCE_PATH <SOURCE_PATH>
|
|
URL <https://android.googlesource.com/platform/external/fdlibm>
|
|
REF <59f7335e4d...>
|
|
[HEAD_REF <ref>]
|
|
[PATCHES <patch1.patch> <patch2.patch>...]
|
|
)
|
|
```
|
|
|
|
## Parameters:
|
|
### OUT_SOURCE_PATH
|
|
Specifies the out-variable that will contain the extracted location.
|
|
|
|
This should be set to `SOURCE_PATH` by convention.
|
|
|
|
### URL
|
|
The url of the git repository.
|
|
|
|
### REF
|
|
The git sha of the commit to download.
|
|
|
|
### HEAD_REF
|
|
The git branch to use when the package is requested to be built from the latest sources.
|
|
|
|
Example: `main`, `develop`, `HEAD`
|
|
|
|
### PATCHES
|
|
A list of patches to be applied to the extracted sources.
|
|
|
|
Relative paths are based on the port directory.
|
|
|
|
## Notes:
|
|
`OUT_SOURCE_PATH`, `REF`, and `URL` must be specified.
|
|
|
|
## Examples:
|
|
|
|
* [fdlibm](https://github.com/Microsoft/vcpkg/blob/master/ports/fdlibm/portfile.cmake)
|
|
|
|
## Source
|
|
[scripts/cmake/vcpkg\_from\_git.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_from_git.cmake)
|