Merge branch 'master' of https://github.com/Microsoft/vcpkg into dev/jack/upgrade_libi

14 files changed, 204 insertions, 57 deletions

diff --git a/docs/about/privacy.md b/docs/about/privacy.md
index 91d709372..542f27614 100644
--- a/docs/about/privacy.md
+++ b/docs/about/privacy.md
@@ -1,51 +1,45 @@
+# Vcpkg telemetry and privacy
 
-# Privacy and Vcpkg
+vcpkg collects telemetry data to understand usage issues, such as failing packages, and to guide tool improvements. The collected data is anonymous.
+For more information about how Microsoft protects your privacy, see https://privacy.microsoft.com/en-US/privacystatement#mainenterprisedeveloperproductsmodule 
 
-## Do you collect telemetry data? What is it used for?
+## Scope
 
-We do collect telemetry data from usage of "vcpkg.exe". We explicitly ONLY collect information from invocations of the tool itself; we do NOT add any tracking information into the produced libraries. We use this information to understand usage issues, such as failing packages, and to guide tool improvements.
+We explicitly ONLY collect information from invocations of the tool itself; we do NOT add any tracking information into the produced libraries. Telemetry is collected when using any of the `vcpkg` commands.
 
-## What telemetry is collected?
+## How to opt out
 
-We collect the command line used, the time of invocation, and how long execution took. Some commands also add additional calculated information (such as the full set of libraries to install). We generate a completely random UUID on first use and attach it to each event.
-In order to opt-out of data collection, you can re-run the boostrap script with the following flag, for Windows and Linux/OSX, respectively:
+The vcpkg telemetry feature is enabled by default. In order to opt-out of data collection, you can re-run the boostrap script with the following flag, for Windows and Linux/OSX, respectively:
 
 ```PS> .\bootstrap-vcpkg.bat -disableMetrics```
 
 ```~/$ ./bootstrap-vcpkg.sh -disableMetrics```
 
-For more information about how Microsoft protects your privacy, see https://privacy.microsoft.com/en-us/privacy.
-
-Here is an example of an event for the command line `vcpkg install zlib`:
-```json
-[{
-    "ver": 1,
-    "name": "Microsoft.ApplicationInsights.Event",
-    "time": "2016-09-01T00:19:10.949Z",
-    "sampleRate": 100.000000,
-    "seq": "0:0",
-    "iKey": "aaaaaaaa-4393-4dd9-ab8e-97e8fe6d7603",
-    "flags": 0.000000,
-    "tags": {
-        "ai.device.os": "Windows",
-        "ai.device.osVersion": "10.0.14912",
-        "ai.session.id": "aaaaaaaa-7c69-4b83-7d82-8a4198d7e88d",
-        "ai.user.id": "aaaaaaaa-c9ab-4bf5-0847-a3455f539754",
-        "ai.user.accountAcquisitionDate": "2016-08-20T00:38:09.860Z"
-    },
-    "data": {
-        "baseType": "EventData",
-        "baseData": {
-            "ver": 2,
-            "name": "commandline_test7",
-            "properties": { "version":"0.0.30-9b4e44a693459c0a618f370681f837de6dd95a30","cmdline":"install zlib","command":"install","installplan":"zlib:x86-windows" },
-            "measurements": { "elapsed_us":68064.355736 }
-        }
-    }
-}]
+## Disclosure
+
+vcpkg displays text similar to the following when you build vcpkg. This is how Microsoft notifies you about data collection.
+
 ```
-In the source code (included in `toolsrc\`), you can search for calls to the functions `TrackProperty()` and `TrackMetric()` to see every specific data point we collect.
+Telemetry
+---------
+vcpkg collects usage data in order to help us improve your experience. The data collected by Microsoft is anonymous. You can opt-out of telemetry by re-running the bootstrap-vcpkg script with -disableMetrics.
+
+Read more about vcpkg telemetry at docs/about/privacy.md
+```
+
+## Data Collected
+
+The telemetry feature doesn't collect personal data, such as usernames or email addresses. It doesn't scan your code and doesn't extract project-level data, such as name, repository, or author. The data is sent securely to Microsoft servers and held under restricted access.
+
+Protecting your privacy is important to us. If you suspect the telemetry is collecting sensitive data or the data is being insecurely or inappropriately handled, file an issue in the Microsoft/vcpkg repository or send an email to vcpkg@microsoft.com for investigation.
+
+We collect various telemetry events such as the command line used, the time of invocation, and how long execution took. Some commands also add additional calculated information (such as the full set of libraries to install). We generate a completely random UUID on first use and attach it to each event.
+
+You can see the telemetry events any command by appending `--printmetrics` after the vcpkg command line.
+
+In the source code (included in `toolsrc\`), you can search for calls to the functions `track_property()` and `track_metric()` to see every specific data point we collect.
 
-## Is the data stored on my system?
+## Avoid inadvertent disclosure information 
 
-We store each event document in your temporary files directory. These will be cleaned out whenever you clear your temporary files.
+vcpkg contributors and anyone else running a version of vcpkg that they built themselves should consider the path to their source code. If a crash occurs when using vcpkg, the file path from the build machine is collected as part of the stack trace and isn't hashed.
+Because of this, builds of vcpkg shouldn't be located in directories whose path names expose personal or sensitive information.
diff --git a/docs/examples/packaging-github-repos.md b/docs/examples/packaging-github-repos.md
index af2e6141a..61e1f9a5d 100644
--- a/docs/examples/packaging-github-repos.md
+++ b/docs/examples/packaging-github-repos.md
@@ -10,13 +10,7 @@ Description: Ogg is a multimedia container format, and the native file and strea
 ```

 

 ### Create the portfile

-`portfile.cmake` describes how to build and install the package. First we include `vcpkg_common_functions` to give us utilities for carrying this out:

-

-```no-highlight

-include(vcpkg_common_functions)

-```

-

-Now we download the project from Github with [`vcpkg_from_github`](../maintainers/vcpkg_from_github.md):

+`portfile.cmake` describes how to build and install the package. First we download the project from Github with [`vcpkg_from_github`](../maintainers/vcpkg_from_github.md):

 

 ```no-highlight

 vcpkg_from_github(

diff --git a/docs/maintainers/control-files.md b/docs/maintainers/control-files.md
index 03bfa113a..a074a7ae2 100644
--- a/docs/maintainers/control-files.md
+++ b/docs/maintainers/control-files.md
@@ -109,7 +109,7 @@ Example:
 Build-Depends: curl[openssl] (!windows&!osx), curl[winssl] (windows), curl[darwinssl] (osx)
 ```
 
-#### Default-Feature
+#### Default-Features
 Comma separated list of optional port features to install by default.
 
 This field is optional.
diff --git a/docs/maintainers/portfile-functions.md b/docs/maintainers/portfile-functions.md
index dac417acf..9ff16fd96 100644
--- a/docs/maintainers/portfile-functions.md
+++ b/docs/maintainers/portfile-functions.md
@@ -6,14 +6,14 @@
 - [vcpkg\_add\_to\_path](vcpkg_add_to_path.md)

 - [vcpkg\_apply\_patches](vcpkg_apply_patches.md)

 - [vcpkg\_build\_cmake](vcpkg_build_cmake.md)

-- [vcpkg\_build\_msbuild](vcpkg_build_msbuild.md)
-- [vcpkg\_build\_make](vcpkg_build_make.md)
+- [vcpkg\_build\_make](vcpkg_build_make.md)

+- [vcpkg\_build\_msbuild](vcpkg_build_msbuild.md)

 - [vcpkg\_build\_nmake](vcpkg_build_nmake.md)

 - [vcpkg\_check\_features](vcpkg_check_features.md)

 - [vcpkg\_check\_linkage](vcpkg_check_linkage.md)

 - [vcpkg\_clean\_msbuild](vcpkg_clean_msbuild.md)

 - [vcpkg\_common\_definitions](vcpkg_common_definitions.md)

-- [vcpkg\_configure\_cmake](vcpkg_configure_cmake.md)
+- [vcpkg\_configure\_cmake](vcpkg_configure_cmake.md)

 - [vcpkg\_configure\_make](vcpkg_configure_make.md)

 - [vcpkg\_copy\_pdbs](vcpkg_copy_pdbs.md)

 - [vcpkg\_copy\_tool\_dependencies](vcpkg_copy_tool_dependencies.md)

@@ -29,8 +29,9 @@
 - [vcpkg\_from\_github](vcpkg_from_github.md)

 - [vcpkg\_from\_gitlab](vcpkg_from_gitlab.md)

 - [vcpkg\_install\_cmake](vcpkg_install_cmake.md)

-- [vcpkg\_install\_msbuild](vcpkg_install_msbuild.md)
-- [vcpkg\_install\_make](vcpkg_install_make.md)
+- [vcpkg\_install\_make](vcpkg_install_make.md)

+- [vcpkg\_install\_msbuild](vcpkg_install_msbuild.md)

 - [vcpkg\_install\_nmake](vcpkg_install_nmake.md)

+- [vcpkg\_install\_qmake](vcpkg_install_qmake.md)

 - [vcpkg\_prettify\_command](vcpkg_prettify_command.md)

 - [vcpkg\_test\_cmake](vcpkg_test_cmake.md)

diff --git a/docs/maintainers/pr-review-checklist.md b/docs/maintainers/pr-review-checklist.md
new file mode 100644
index 000000000..44aa46741
--- /dev/null
+++ b/docs/maintainers/pr-review-checklist.md
@@ -0,0 +1,106 @@
+Vcpkg PR Checklist
+=====================
+Revision: 0
+
+## Overview
+This document provides an annotated checklist which vcpkg team members use to apply the "reviewed" label on incoming pull requests. If a pull request violates any of these points, we may ask contributors to make necessary changes before we can merge the changeset.
+
+Feel free to create an issue or pull request if you feel that this checklist can be improved. Please increment the revision number when modifying the checklist content.
+
+## Checklist
+You can link any of these checklist items in a GitHub comment by copying the link address attached to each item code.
+
+<details id=c000001>
+<summary><a href=#c000001>c000001</a>: No deprecated helper functions are used</summary>
+
+See our [Maintainer Guidelines and Policies](maintainer-guide.md#Avoid-deprecated-helper-functions) for more information.
+
+</details>
+
+<details id=c000002>
+<summary><a href=#c000002>c000002</a>: Control Version field is updated</summary>
+
+See our [Maintainer Guidelines and Policies](maintainer-guide.md#versioning) for more information.
+
+</details>
+
+<details id=c000003>
+<summary><a href=#c000003>c000003</a>: New ports contain a Description field written in English</summary>
+
+A description only one or a few sentences long is helpful. Consider using the library's official description from their `README.md` or similar if possible. Automatic translations are acceptable and we are happy to clean up translations to English for our contributors.
+
+See our [CONTROL file documentation](https://github.com/grdowns/vcpkg/blob/pr-checklist/docs/maintainers/control-files.md#description) for more information.
+    
+</details>
+
+<details id=c000004>
+    <summary><a href=#c000004>c000004</a>: No unnecessary comments are present in the changeset</summary>
+
+See our [Maintainer Guidelines and Policies](maintainer-guide.md#Avoid-excessive-comments-in-portfiles) for more information.
+
+</details>
+
+<details id=c000005>
+<summary><a href=#c000005>c000005</a>: Downloaded archives are versioned if available</summary
+
+To ensure archive content does not change, archives downloaded preferably have an associated version tag that can be incremented alongside the port version.
+
+</details>
+
+<details id=c000006>
+<summary><a href=#c000006>c000006</a>: New ports pass CI checks for triplets that the library officially supports</summary>
+
+To ensure vcpkg ports are of a high quality, we ask that incoming ports support the official platforms for the library in question.
+
+</details>
+
+<details id=c000007>
+<summary><a href=#c000007>c000007</a>: Patches fix issues that are vcpkg-specific only</summary>
+
+If possible, patches to the library source code should be upstreamed to the library's official repository. Opening up a pull request on the library's repository will help to improve the library for everyone, not just vcpkg users.
+
+</details>
+
+<details id=c000008>
+<summary><a href=#c000008>c000008</a>: New ports download source code from the official source if available</summary>
+
+To respect library authors and keep code secure, please have ports download source code from the official source. We may make exceptions if the original source code is not available and there is substantial community interest in maintaining the library in question.
+
+</details>
+
+<details id=c000009>
+<summary><a href=#c000010>c000010</a>: Ports and port features are named correctly</summary>
+
+For user accessibility, we prefer names of ports and port features to be intuitive and close to their counterparts in official sources and other package managers. If you are unsure about the naming of a port or port feature, we recommend checking repology.org, packages.ubuntu.com, or searching for additional information using a search engine. We can also help our contributors with this, so feel free to ask for naming suggestions if you are unsure.
+
+</details>
+
+<details id=c000010>
+<summary><a href=#c000011>c000011</a>: Library targets are exported when appropriate</summary>
+
+To provide users with a seamless build system integration, please be sure to export and provide a means of finding the library targets intended to be used downstream. Targets not meant to be exported should be be marked private and not exported.
+
+</details>
+
+<details id=c000011>
+<summary><a href=#c000012>c000012</a>: Ports do not use applications which modify the user's system</summary>
+    
+Ports should uphold vcpkg's contract of not modifying the user's system by avoiding applications which do so. Examples of these applications are `sudo`, `apt`, `brew`, or `pip`. Please use an alternative to these types of programs wherever possible.
+
+</details>
+
+<details id=c000012>
+<summary><a href=#c000013>c000013</a>: Ports with system dependencies include an information message during installation</summary>
+
+Some ports have library and tool dependencies that do not exist within vcpkg. For these missing dependencies, we ask that contributors add a message to the top of the port's `portfile.cmake` stating the missing dependencies and how to acquire them. We ask that the message is displayed before any major work is done to ensure that users can "early out" of the installation process as soon as possible in case they are missing the dependency.
+
+Example:
+```cmake
+message(
+"${PORT} currently requires the following libraries from the system package manager:
+    autoconf libtool
+These can be installed on Ubuntu systems via sudo apt install autoconf libtool"
+)
+```
+
+</details>
diff --git a/docs/maintainers/vcpkg_build_nmake.md b/docs/maintainers/vcpkg_build_nmake.md
index e5c177b1b..c9f4cc5d9 100644
--- a/docs/maintainers/vcpkg_build_nmake.md
+++ b/docs/maintainers/vcpkg_build_nmake.md
@@ -7,8 +7,8 @@ Build a msvc makefile project.
 vcpkg_build_nmake(
     SOURCE_PATH <${SOURCE_PATH}>
     [NO_DEBUG]
-    PROJECT_SUBPATH <${SUBPATH}>
-    PROJECT_NAME <${MAKEFILE_NAME}>
+    [PROJECT_SUBPATH <${SUBPATH}>]
+    [PROJECT_NAME <${MAKEFILE_NAME}>]
     [PRERUN_SHELL <${SHELL_PATH}>]
     [PRERUN_SHELL_DEBUG <${SHELL_PATH}>]
     [PRERUN_SHELL_RELEASE <${SHELL_PATH}>]
diff --git a/docs/maintainers/vcpkg_common_definitions.md b/docs/maintainers/vcpkg_common_definitions.md
index 3bb922b17..276e04190 100644
--- a/docs/maintainers/vcpkg_common_definitions.md
+++ b/docs/maintainers/vcpkg_common_definitions.md
@@ -5,14 +5,22 @@ File contains helpful variabls for portfiles which are commonly needed or used.
 ## The following variables are available:
 ```cmake
 VCPKG_TARGET_IS_<target>                 with <target> being one of the following: WINDOWS, UWP, LINUX, OSX, ANDROID, FREEBSD. only defined if <target>
+VCPKG_HOST_PATH_SEPARATOR                Host specific path separator (USAGE: "<something>${VCPKG_HOST_PATH_SEPARATOR}<something>"; only use and pass variables with VCPKG_HOST_PATH_SEPARATOR within "")
+VCPKG_HOST_EXECUTABLE_SUFFIX             executable suffix of the host
+VCPKG_TARGET_EXECUTABLE_SUFFIX           executable suffix of the target
 VCPKG_TARGET_STATIC_LIBRARY_PREFIX       static library prefix for target (same as CMAKE_STATIC_LIBRARY_PREFIX)
 VCPKG_TARGET_STATIC_LIBRARY_SUFFIX       static library suffix for target (same as CMAKE_STATIC_LIBRARY_SUFFIX)
 VCPKG_TARGET_SHARED_LIBRARY_PREFIX       shared library prefix for target (same as CMAKE_SHARED_LIBRARY_PREFIX)
 VCPKG_TARGET_SHARED_LIBRARY_SUFFIX       shared library suffix for target (same as CMAKE_SHARED_LIBRARY_SUFFIX)
+VCPKG_TARGET_IMPORT_LIBRARY_PREFIX       import library prefix for target (same as CMAKE_IMPORT_LIBRARY_PREFIX)
+VCPKG_TARGET_IMPORT_LIBRARY_SUFFIX       import library suffix for target (same as CMAKE_IMPORT_LIBRARY_SUFFIX)
+VCPKG_FIND_LIBRARY_PREFIXES              target dependent prefixes used for find_library calls in portfiles
+VCPKG_FIND_LIBRARY_SUFFIXES              target dependent suffixes used for find_library calls in portfiles
 ```
 
-CMAKE_STATIC_LIBRARY_PREFIX, CMAKE_STATIC_LIBRARY_SUFFIX, CMAKE_SHARED_LIBRARY_PREFIX, CMAKE_SHARED_LIBRARY_SUFFIX are defined for the target so that 
-portfiles are able to use find_library calls to discover dependent libraries within the current triplet for ports. 
+CMAKE_STATIC_LIBRARY_(PREFIX|SUFFIX), CMAKE_SHARED_LIBRARY_(PREFIX|SUFFIX) and CMAKE_IMPORT_LIBRARY_(PREFIX|SUFFIX) are defined for the target
+Furthermore the variables CMAKE_FIND_LIBRARY_(PREFIXES|SUFFIXES) are also defined for the target so that
+portfiles are able to use find_library calls to discover dependent libraries within the current triplet for ports.
 
 
 ## Source
diff --git a/docs/maintainers/vcpkg_configure_make.md b/docs/maintainers/vcpkg_configure_make.md
index 73b46bafc..a18621794 100644
--- a/docs/maintainers/vcpkg_configure_make.md
+++ b/docs/maintainers/vcpkg_configure_make.md
@@ -1,6 +1,6 @@
 # vcpkg_configure_make
 
-Configure `configure` for Debug and Release builds of a project.
+Configure configure for Debug and Release builds of a project.
 
 ## Usage
 ```cmake
diff --git a/docs/maintainers/vcpkg_download_distfile.md b/docs/maintainers/vcpkg_download_distfile.md
index 2e86b8f7c..18bdf9dc7 100644
--- a/docs/maintainers/vcpkg_download_distfile.md
+++ b/docs/maintainers/vcpkg_download_distfile.md
@@ -45,7 +45,7 @@ The helper [`vcpkg_from_github`](vcpkg_from_github.md) should be used for downlo
 
 * [apr](https://github.com/Microsoft/vcpkg/blob/master/ports/apr/portfile.cmake)
 * [fontconfig](https://github.com/Microsoft/vcpkg/blob/master/ports/fontconfig/portfile.cmake)
-* [openssl](https://github.com/Microsoft/vcpkg/blob/master/ports/openssl/portfile.cmake)
+* [freetype](https://github.com/Microsoft/vcpkg/blob/master/ports/freetype/portfile.cmake)
 
 ## Source
 [scripts/cmake/vcpkg_download_distfile.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_download_distfile.cmake)

diff --git a/docs/maintainers/vcpkg_extract_source_archive_ex.md b/docs/maintainers/vcpkg_extract_source_archive_ex.md
index 8f525c3ce..90dafb6be 100644
--- a/docs/maintainers/vcpkg_extract_source_archive_ex.md
+++ b/docs/maintainers/vcpkg_extract_source_archive_ex.md
@@ -5,6 +5,7 @@ Extract an archive into the source directory. Replaces [`vcpkg_extract_source_ar
 ## Usage
 ```cmake
 vcpkg_extract_source_archive_ex(
+    SKIP_PATCH_CHECK
     OUT_SOURCE_PATH <SOURCE_PATH>
     ARCHIVE <${ARCHIVE}>
     [REF <1.0.0>]
@@ -14,6 +15,9 @@ vcpkg_extract_source_archive_ex(
 )
 ```
 ## Parameters
+### SKIP_PATCH_CHECK
+If this option is set the failure to apply a patch is ignored.
+
 ### OUT_SOURCE_PATH
 Specifies the out-variable that will contain the extracted location.
 
diff --git a/docs/maintainers/vcpkg_find_acquire_program.md b/docs/maintainers/vcpkg_find_acquire_program.md
index b868ea418..106bbe4b7 100644
--- a/docs/maintainers/vcpkg_find_acquire_program.md
+++ b/docs/maintainers/vcpkg_find_acquire_program.md
@@ -20,6 +20,7 @@ The current list of programs includes:
 - PERL
 - PYTHON2
 - PYTHON3
+- GO
 - JOM
 - MESON
 - NASM
diff --git a/docs/maintainers/vcpkg_from_github.md b/docs/maintainers/vcpkg_from_github.md
index 8f9731629..18ab5b976 100644
--- a/docs/maintainers/vcpkg_from_github.md
+++ b/docs/maintainers/vcpkg_from_github.md
@@ -11,6 +11,8 @@ vcpkg_from_github(
     [SHA512 <45d0d7f8cc350...>]
     [HEAD_REF <master>]
     [PATCHES <patch1.patch> <patch2.patch>...]
+    [GITHUB_HOST <https://github.com>]
+    [AUTHORIZATION_TOKEN <${SECRET_FROM_FILE}>]
 )
 ```
 
@@ -45,6 +47,14 @@ A list of patches to be applied to the extracted sources.
 
 Relative paths are based on the port directory.
 
+### GITHUB_HOST
+A replacement host for enterprise GitHub instances.
+
+This field should contain the scheme, host, and port of the desired URL without a trailing slash.
+
+### AUTHORIZATION_TOKEN
+A token to be passed via the Authorization HTTP header as "token ${AUTHORIZATION_TOKEN}".
+
 ## Notes:
 At least one of `REF` and `HEAD_REF` must be specified, however it is preferable for both to be present.
 
diff --git a/docs/maintainers/vcpkg_install_nmake.md b/docs/maintainers/vcpkg_install_nmake.md
index 3f397c195..e83b05ff7 100644
--- a/docs/maintainers/vcpkg_install_nmake.md
+++ b/docs/maintainers/vcpkg_install_nmake.md
@@ -56,5 +56,10 @@ See [`vcpkg_build_nmake()`](vcpkg_build_nmake.md).
 ## Notes:
 This command transparently forwards to [`vcpkg_build_nmake()`](vcpkg_build_nmake.md), adding `ENABLE_INSTALL`
 
+## Examples
+
+* [tcl](https://github.com/Microsoft/vcpkg/blob/master/ports/tcl/portfile.cmake)
+* [freexl](https://github.com/Microsoft/vcpkg/blob/master/ports/freexl/portfile.cmake)
+
 ## Source
 [scripts/cmake/vcpkg_install_nmake.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_install_nmake.cmake)

diff --git a/docs/maintainers/vcpkg_install_qmake.md b/docs/maintainers/vcpkg_install_qmake.md
new file mode 100644
index 000000000..cbf08aa3e
--- /dev/null
+++ b/docs/maintainers/vcpkg_install_qmake.md
@@ -0,0 +1,24 @@
+# vcpkg_install_qmake
+
+Build and install a qmake project.
+
+## Usage:
+```cmake
+vcpkg_install_qmake(...)
+```
+
+## Parameters:
+See [`vcpkg_build_qmake()`](vcpkg_build_qmake.md).
+
+## Notes:
+This command transparently forwards to [`vcpkg_build_qmake()`](vcpkg_build_qmake.md).
+
+Additionally, this command will copy produced .libs/.dlls/.as/.dylibs/.sos to the appropriate
+staging directories.
+
+## Examples
+
+* [libqglviewer](https://github.com/Microsoft/vcpkg/blob/master/ports/libqglviewer/portfile.cmake)
+
+## Source
+[scripts/cmake/vcpkg_install_qmake.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_install_qmake.cmake)