diff options
| author | Robert Schumacher <roschuma@microsoft.com> | 2018-08-11 22:12:18 -0700 |
|---|---|---|
| committer | Robert Schumacher <roschuma@microsoft.com> | 2018-08-11 22:12:18 -0700 |
| commit | 393ac2880a72d10cac1e1f19e7787c2eb9573abe (patch) | |
| tree | 74d9099899877fe0ca98322359ff56636fcef44a /scripts | |
| parent | 50f45eb230b339828cea9a1ee149c57bc1422355 (diff) | |
| download | vcpkg-393ac2880a72d10cac1e1f19e7787c2eb9573abe.tar.gz vcpkg-393ac2880a72d10cac1e1f19e7787c2eb9573abe.zip | |
[vcpkg_from_github] Improve documentation to include PATCHES argument
Diffstat (limited to 'scripts')
| -rw-r--r-- | scripts/cmake/vcpkg_from_github.cmake | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/scripts/cmake/vcpkg_from_github.cmake b/scripts/cmake/vcpkg_from_github.cmake index 68baa908e..33de8354d 100644 --- a/scripts/cmake/vcpkg_from_github.cmake +++ b/scripts/cmake/vcpkg_from_github.cmake @@ -10,6 +10,7 @@ ## [REF <v2.0.0>] ## [SHA512 <45d0d7f8cc350...>] ## [HEAD_REF <master>] +## [PATCHES <patch1.patch> <patch2.patch>...] ## ) ## ``` ## @@ -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. ## |