From 393ac2880a72d10cac1e1f19e7787c2eb9573abe Mon Sep 17 00:00:00 2001 From: Robert Schumacher Date: Sat, 11 Aug 2018 22:12:18 -0700 Subject: [PATCH] [vcpkg_from_github] Improve documentation to include PATCHES argument --- docs/maintainers/vcpkg_from_github.md | 8 +++++++- scripts/cmake/vcpkg_from_github.cmake | 8 +++++++- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/maintainers/vcpkg_from_github.md b/docs/maintainers/vcpkg_from_github.md index cf50dc44584..8f9731629d9 100644 --- a/docs/maintainers/vcpkg_from_github.md +++ b/docs/maintainers/vcpkg_from_github.md @@ -10,6 +10,7 @@ vcpkg_from_github( [REF ] [SHA512 <45d0d7f8cc350...>] [HEAD_REF ] + [PATCHES ...] ) ``` @@ -23,7 +24,7 @@ This should be set to `SOURCE_PATH` by convention. The organization or user and repository on GitHub. ### REF -A stable git commit-ish (ideally a tag) that will not change contents. **This should not be a branch.** +A stable git commit-ish (ideally a tag or commit) that will not change contents. **This should not be a branch.** For repositories without official releases, this can be set to the full commit id of the current latest master. @@ -39,6 +40,11 @@ The unstable git commit-ish (ideally a branch) to pull for `--head` builds. For most projects, this should be `master`. The chosen branch should be one that is expected to be always buildable on all supported platforms. +### PATCHES +A list of patches to be applied to the extracted sources. + +Relative paths are based on the port directory. + ## Notes: At least one of `REF` and `HEAD_REF` must be specified, however it is preferable for both to be present. diff --git a/scripts/cmake/vcpkg_from_github.cmake b/scripts/cmake/vcpkg_from_github.cmake index 68baa908ed7..33de8354dcc 100644 --- a/scripts/cmake/vcpkg_from_github.cmake +++ b/scripts/cmake/vcpkg_from_github.cmake @@ -10,6 +10,7 @@ ## [REF ] ## [SHA512 <45d0d7f8cc350...>] ## [HEAD_REF ] +## [PATCHES ...] ## ) ## ``` ## @@ -23,7 +24,7 @@ ## The organization or user and repository on GitHub. ## ## ### REF -## A stable git commit-ish (ideally a tag) that will not change contents. **This should not be a branch.** +## A stable git commit-ish (ideally a tag or commit) that will not change contents. **This should not be a branch.** ## ## For repositories without official releases, this can be set to the full commit id of the current latest master. ## @@ -39,6 +40,11 @@ ## ## For most projects, this should be `master`. The chosen branch should be one that is expected to be always buildable on all supported platforms. ## +## ### PATCHES +## A list of patches to be applied to the extracted sources. +## +## Relative paths are based on the port directory. +## ## ## Notes: ## At least one of `REF` and `HEAD_REF` must be specified, however it is preferable for both to be present. ##