[ceph.git] / ceph / src / jaegertracing / opentelemetry-cpp / tools / vcpkg / docs / maintainers / vcpkg_from_git.md

# 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...>
    [TAG <v1.0.2>]
    [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.

### TAG
An optional git tag to be verified against the `REF`. If the remote repository's tag does not match the specified `REF`, the build will fail.

### PATCHES
A list of patches to be applied to the extracted sources.

Relative paths are based on the port directory.

### X_OUT_REF (internal only)
This parameter is used for automatic REF updates for certain ports in the central vcpkg catalog. It should not be used by any ports outside the central catalog and within the central catalog it should not be used on any user path. This parameter may change behavior incompatibly or be removed at any time.

## 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)
Commit	Line	Data
1e59de90 TL	1	# vcpkg_from_git
	2
	3	The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/vcpkg_from_git.md).
	4
	5	Download and extract a project from git
	6
	7	## Usage:
	8	```cmake
	9	vcpkg_from_git(
	10	OUT_SOURCE_PATH <SOURCE_PATH>
	11	URL <https://android.googlesource.com/platform/external/fdlibm>
	12	REF <59f7335e4d...>
	13	[TAG <v1.0.2>]
	14	[PATCHES <patch1.patch> <patch2.patch>...]
	15	)
	16	```
	17
	18	## Parameters:
	19	### OUT_SOURCE_PATH
	20	Specifies the out-variable that will contain the extracted location.
	21
	22	This should be set to `SOURCE_PATH` by convention.
	23
	24	### URL
	25	The url of the git repository.
	26
	27	### REF
	28	The git sha of the commit to download.
	29
	30	### TAG
	31	An optional git tag to be verified against the `REF`. If the remote repository's tag does not match the specified `REF`, the build will fail.
	32
	33	### PATCHES
	34	A list of patches to be applied to the extracted sources.
	35
	36	Relative paths are based on the port directory.
	37
	38	### X_OUT_REF (internal only)
	39	This parameter is used for automatic REF updates for certain ports in the central vcpkg catalog. It should not be used by any ports outside the central catalog and within the central catalog it should not be used on any user path. This parameter may change behavior incompatibly or be removed at any time.
	40
	41	## Notes:
	42	`OUT_SOURCE_PATH`, `REF`, and `URL` must be specified.
	43
	44	## Examples:
	45
	46	* [fdlibm](https://github.com/Microsoft/vcpkg/blob/master/ports/fdlibm/portfile.cmake)
	47
	48	## Source
	49	[scripts/cmake/vcpkg\_from\_git.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_from_git.cmake)