vcpkg/docs/maintainers/vcpkg_from_git.md
nicole mazzuca 99e06a64ec
[rollup:2021-08-09] Rollup PR ()
* [rollup:2021-08-09] PR  (@JackBoosY)

[vcpkg_fixup_cmake_targets] Fix up OSX system development path

* [rollup:2021-08-09] PR  (@strega-nil)

[scripts-audit] vcpkg_download_distfile

* [rollup:2021-08-09] PR  (@strega-nil)

[scripts-audit] vcpkg_find_fortran

* [rollup:2021-08-09] PR  (@strega-nil)

[tinyfiledialogs] Fix for good

* [rollup:2021-08-09] PR  (@strega-nil)

[scripts-audit] vcpkg_fixup_pkgconfig

* fix ports.cmake with newer vcpkg_download_distfile

* fix vcpkg create

* move vcpkg_common_definitions down so that it's not incorrect

* fix vcpkg_internal_get_cmake_vars

Co-authored-by: nicole mazzuca <mazzucan@outlook.com>
Co-authored-by: Jack·Boos·Yu <47264268+JackBoosY@users.noreply.github.com>
Co-authored-by: Billy Robert O'Neal III <bion@microsoft.com>
2021-08-16 13:42:31 -07:00

1.4 KiB

vcpkg_from_git

The latest version of this document lives in the vcpkg repo.

Download and extract a project from git

Usage:

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.

FETCH_REF

The git branch to fetch in non-HEAD mode. After this is fetched, then REF is checked out. This is useful in cases where the git server does not allow checking out non-advertised objects.

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:

Source

scripts/cmake/vcpkg_from_git.cmake