diff options
| author | Alexander Neumann <30894796+Neumann-A@users.noreply.github.com> | 2021-01-11 09:27:56 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-11 00:27:56 -0800 |
| commit | 0b16dbc1cfb44e80a0819510a72c1ca35dca1b2f (patch) | |
| tree | 45aef4be1673fb65cd3ff38419af14dbdc2b2d5b /docs | |
| parent | 6b2f51fc7aa3c8123e591a7726bb0946ba7dbf79 (diff) | |
| download | vcpkg-0b16dbc1cfb44e80a0819510a72c1ca35dca1b2f.tar.gz vcpkg-0b16dbc1cfb44e80a0819510a72c1ca35dca1b2f.zip | |
[vcpkg_from_git] new options TAG and X_OUT_REF (#15049)
* [vcpkg_from_git] new options TAG and OUT_REF
- TAG github tag to checkout
- OUT_REF github commit id related to tag or ref
(useable for automatic updates of ports if used with a version tag)
* Apply suggestions from code review
Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
* additional changes due to CR
* regenerate docs
Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/maintainers/vcpkg_from_git.md | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/maintainers/vcpkg_from_git.md b/docs/maintainers/vcpkg_from_git.md index 2feed49aa..cb3b9c67f 100644 --- a/docs/maintainers/vcpkg_from_git.md +++ b/docs/maintainers/vcpkg_from_git.md @@ -8,6 +8,7 @@ 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>...] ) ``` @@ -24,11 +25,17 @@ 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. |