aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRobert Schumacher <roschuma@microsoft.com>2018-08-11 22:12:18 -0700
committerRobert Schumacher <roschuma@microsoft.com>2018-08-11 22:12:18 -0700
commit393ac2880a72d10cac1e1f19e7787c2eb9573abe (patch)
tree74d9099899877fe0ca98322359ff56636fcef44a /docs
parent50f45eb230b339828cea9a1ee149c57bc1422355 (diff)
downloadvcpkg-393ac2880a72d10cac1e1f19e7787c2eb9573abe.tar.gz
vcpkg-393ac2880a72d10cac1e1f19e7787c2eb9573abe.zip
[vcpkg_from_github] Improve documentation to include PATCHES argument
Diffstat (limited to 'docs')
-rw-r--r--docs/maintainers/vcpkg_from_github.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/maintainers/vcpkg_from_github.md b/docs/maintainers/vcpkg_from_github.md
index cf50dc445..8f9731629 100644
--- a/docs/maintainers/vcpkg_from_github.md
+++ b/docs/maintainers/vcpkg_from_github.md
@@ -10,6 +10,7 @@ vcpkg_from_github(
[REF <v2.0.0>]
[SHA512 <45d0d7f8cc350...>]
[HEAD_REF <master>]
+ [PATCHES <patch1.patch> <patch2.patch>...]
)
```
@@ -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.