diff options
| author | Alexander Karatarakis <alkarata@microsoft.com> | 2018-06-08 16:33:38 -0700 |
|---|---|---|
| committer | Alexander Karatarakis <alkarata@microsoft.com> | 2018-06-08 16:33:38 -0700 |
| commit | 39c70573df301fb5e4297abbc7f05cc05c0af0a4 (patch) | |
| tree | 640f7898e4f65bd6ecf2a9de663398d687cac2aa /docs | |
| parent | 91ec5c430131b3364a8cd076e02570e2e99dfb71 (diff) | |
| download | vcpkg-39c70573df301fb5e4297abbc7f05cc05c0af0a4.tar.gz vcpkg-39c70573df301fb5e4297abbc7f05cc05c0af0a4.zip | |
Update documentation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/about/faq.md | 2 | ||||
| -rw-r--r-- | docs/about/privacy.md | 7 | ||||
| -rw-r--r-- | docs/index.md | 2 |
3 files changed, 8 insertions, 3 deletions
diff --git a/docs/about/faq.md b/docs/about/faq.md index 87496da44..ff7ecdba5 100644 --- a/docs/about/faq.md +++ b/docs/about/faq.md @@ -42,7 +42,7 @@ See the [Privacy document](privacy.md) for all information regarding privacy. Yes. If you already have a CMake toolchain file, you will need to include our toolchain file at the end of yours. This should be as simple as an `include(<vcpkg_root>\scripts\buildsystems\vcpkg.cmake)` directive. Alternatively, you could copy the contents of our `scripts\buildsystems\vcpkg.cmake` into the end of your existing toolchain file. ## Can I use my own/specific flags for rebuilding libs? -Yes. In the current preview, there is not yet a standardized global way to change them, however you can edit individual portfiles and tweak the exact build process however you'd like. +Yes. In the current version, there is not yet a standardized global way to change them, however you can edit individual portfiles and tweak the exact build process however you'd like. By saving the changes to the portfile (and checking them in), you'll get the same results even if you're rebuilding from scratch in the future and forgot what exact settings you used. diff --git a/docs/about/privacy.md b/docs/about/privacy.md index 9ff0e7a47..419a25faf 100644 --- a/docs/about/privacy.md +++ b/docs/about/privacy.md @@ -7,7 +7,12 @@ We do collect telemetry data from usage of "vcpkg.exe". We explicitly ONLY colle ## What telemetry is collected? -We collect the command line used, the time of invocation, and how long the command 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. For this preview, we do not offer a mechanism to disable this data collection since it is critical for improving the product. In the full release, you will be able to opt-out with a simple configuration. For more information about how Microsoft protects your privacy, see https://privacy.microsoft.com/en-us/privacy. +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: + +```PS> .\bootstrap-vcpkg.bat -disableMetrics 1``` + +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 diff --git a/docs/index.md b/docs/index.md index c34715a27..90245d36a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ ### Quick Start -Vcpkg helps you get C and C++ libraries on Windows. This tool and ecosystem are currently in a preview state; your involvement is vital to its success. +Vcpkg helps you manage C and C++ libraries on Windows, Linux and MacOS. This tool and ecosystem are constantly evolving; your involvement are vital to its success! - [How to use Sqlite in your application](examples/using-sqlite.md) |