diff options
| author | Robert Schumacher <roschuma@microsoft.com> | 2017-07-18 12:26:55 -0700 |
|---|---|---|
| committer | Robert Schumacher <roschuma@microsoft.com> | 2017-07-18 12:26:55 -0700 |
| commit | 2807fce1ab3e77e8a59ab18adf0c11a610e24fc5 (patch) | |
| tree | 7d00c294c8ae15c87c4c10f321da262468494ab5 /scripts | |
| parent | 8dcf40daece7294e2a584a60c51ea86cf731686a (diff) | |
| download | vcpkg-2807fce1ab3e77e8a59ab18adf0c11a610e24fc5.tar.gz vcpkg-2807fce1ab3e77e8a59ab18adf0c11a610e24fc5.zip | |
[vcpkg-from-github] Improve documentation (#1457)
Diffstat (limited to 'scripts')
| -rw-r--r-- | scripts/cmake/vcpkg_from_github.cmake | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/scripts/cmake/vcpkg_from_github.cmake b/scripts/cmake/vcpkg_from_github.cmake index 0ce485954..645690353 100644 --- a/scripts/cmake/vcpkg_from_github.cmake +++ b/scripts/cmake/vcpkg_from_github.cmake @@ -23,7 +23,9 @@ ## The organization or user and repository on GitHub. ## ## ### REF -## A stable git commit-ish (ideally a tag) that will not change contents. +## A stable git commit-ish (ideally a tag) 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. ## ## If `REF` is specified, `SHA512` must also be specified. ## @@ -38,7 +40,7 @@ ## For most projects, this should be `master`. The chosen branch should be one that is expected to be always buildable on all supported platforms. ## ## ## Notes: -## At least one of `REF` and `HEAD_REF` must be specified. +## At least one of `REF` and `HEAD_REF` must be specified, however it is preferable for both to be present. ## ## This exports the `VCPKG_HEAD_VERSION` variable during head builds. ## |