aboutsummaryrefslogtreecommitdiff
path: root/docs/users
AgeCommit message (Collapse)Author
2021-10-14docs: You can use the msbuild interation with multiple triplets since #19767 ↵autoantwort
(#20717)
2021-09-02[vcpkg] Repair msbuild damage and workaround the way we integrate on VS2015. ↵Billy O'Neal
(#19767) * Repair msbuild damage and workaround the way we integrate on VS2015. This is a fix for a pile of issues discovered by https://github.com/microsoft/vcpkg/pull/18906 * VS 2015 has a bug that the <VcpkgInstalledDir Condition="!$(VcpkgInstalledDir.EndsWith('\'))">$(VcpkgInstalledDir)\</VcpkgInstalledDir> dance we do to get a trailing slash is not applied correctly when VcpkgInstalledDir was edited in the same property group attempting to add the trailing slash. * We need a trailing slash on VcpkgInstalledDir at all times, but https://github.com/microsoft/vcpkg/pull/16173 damaged this by removing it from TreatAsLocalProperty. Add the right TreatAsLocalPropertys back. Add all such slash defenses to the top of the file just beneath, eliminating need to call Path::Combine and friends by following msbuild "directory properties have a trailing slash" convention. * Move VcpkgOSTarget and VcpkgPlatformTarget into the .targets, as they aren't intended to be overridable by users and don't appear in our selection dialog box(es). * Don't bother avoiding setting vcpkg properties when VcpkgEnabled is off; after all, VcpkgEnabled is itself a vcpkg property :). I left attempts to skip creating items since creating items can hit the disk. * Add _Z to several internal msbuild variables. * Move VcpkgApplocalDeps to the .props since it's a user setting. * Don't unconditionally use $(TLogLocation) because it is not set on 2015, and also it's per-project. * Fixed typo in docs "VcpkgInstalledDirectory", and document the limitation that it doesn't work in 2015. * In manifest mode, put the installed tree in a subdirectory including the triplet to make changing configurations faster. Known limitations: * If you change vcpkg.json without changing any .cpp files, we don't rebuild the dependencies even though we should. I don't know how to fix this but it doesn't appear to be a regression. * Fix .tlog handling. * Further defend against modified properties on VS2015. * Document more VS2015 limitations. * Remove TreatAsLocalProperty comment.
2021-08-30[docs] improve integrate documentation (#19700)autoantwort
* [docs] improve integrate documentation * Small suggestions Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-08-25[vcpkg] Add triplet option VCPKG_NO_COMPILER_TRACKING (#17526)Kevin Lalumiere
2021-08-17[docs] Improve assetcaching.md (#19625)autoantwort
* Improve asset caching readme * Update assetcaching.md Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-08-03Fix title capitalization from ↵Billy O'Neal
https://github.com/vcpkg/vcpkg.github.io/pull/54 (#19345)
2021-07-23[docs] Describe nugettimeout option in binarycaching (#19084)Eric Kilmer
2021-07-20[docs] More Getting Started fixes (#18970)Victor Romero
* Use valid commmit ID for baseline * More doc fixes
2021-07-06[binarycaching.md] Improve Azure DevOps example (#18807)Julian Xhokaxhiu
Add a missing, but required task for Azure DevOps Pipelines, to automatically authenticate against the Artifacts registry. This should help any vcpkg newcomer to integrate easily.
2021-06-23[vcpkg.cmake] PREPEND CMAKE_FIND_ROOT_PATH (#17336)autoantwort
* [vcpkg.cmake] PREPEND CMAKE_FIND_ROOT_PATH * [vcpkg.cmake] make PREPEND optional (default off, option VCPKG_PREFER_VCPKG_LIBS) * Apply suggestions from code review Co-authored-by: nicole mazzuca <mazzucan@outlook.com> * Update scripts/buildsystems/vcpkg.cmake Co-authored-by: nicole mazzuca <83086508+strega-nil-ms@users.noreply.github.com> Co-authored-by: nicole mazzuca <mazzucan@outlook.com>
2021-06-08Add VCPKG_MAKE_CONFIGURE_OPTIONS (that can be set in the triplet) (#18132)pastdue
* Add VCPKG_MAKE_CONFIGURE_OPTIONS that can be set in the triplet To append options to the configure command * Add documentation * Expand without quotes Co-Authored-By: ras0219 <533828+ras0219@users.noreply.github.com> * Add VCPKG_CMAKE_CONFIGURE_OPTIONS that can be set in the triplet Co-Authored-By: Jack·Boos·Yu <47264268+JackBoosY@users.noreply.github.com> * Bump vcpkg-cmake port-version * Run x-add-version vcpkg-cmake * Apply suggestions from code review * [vcpkg-cmake] add version Co-authored-by: ras0219 <533828+ras0219@users.noreply.github.com> Co-authored-by: Jack·Boos·Yu <47264268+JackBoosY@users.noreply.github.com> Co-authored-by: nicole mazzuca <83086508+strega-nil-ms@users.noreply.github.com> Co-authored-by: nicole mazzuca <mazzucan@outlook.com>
2021-06-04[vcpkg] Add experimental $X_VCPKG_ASSET_SOURCES for source caching (#13639)ras0219
* [vcpkg] Add experimental $VCPKG_X_READWRITE_MIRROR_URL_TEMPLATE for source caching * [vcpkg] Use prerelease version for testing * [docs] Add assetcaching.md * Revert bootstrap changes * [vcpkg_download_distfile] Deprecate SILENT_EXIT * cmake_parse_arguments() always defines option arguments * Adjust CI baseline * [vcpkg_download_distfile] Address CR comments, restore ARIA2 * [CI] Add source caching to Linux and OSX CI passes * [ci.baseline.txt] Skip chartdir on more platforms
2021-06-03[docs] Updated list of off-by-default features (#18258)Mats Taraldsvik
2021-05-26[Doc] Update binarycaching.md with clearer description (#18033)Augustin Popa
* Update binarycaching.md with clearer description We received user feedback about the binary caching feature not being clear. I rewrote some of the opening section to try to describe it better. Feedback is appreciated. * Apply suggestions from code review Co-authored-by: ras0219 <533828+ras0219@users.noreply.github.com> Co-authored-by: ras0219 <533828+ras0219@users.noreply.github.com>
2021-05-21[native supports-expr] docs changes (#16971)nicole mazzuca
2021-05-09[doc] Fix spelling errors (#17560)Kai Pastor
* [doc] Fix spelling errors in docs * [doc] Fix spelling errors in scripts * Bump version * x-add-version * Fix another typo * Rebuild
2021-05-06[docs registries] Add reference documentation (#17672)nicole mazzuca
* using registries reference documentation * start work on "creating registries" document also fix minor issue in "using registries" doc * Robert's comments, continue working * finish creating registries docs * add links to example registries * aupopa cr
2021-05-03[docs] Consolidate versioning documentation (#17580)Robert Schumacher
Co-authored-by: Robert Schumacher <ras0219@outlook.com>
2021-04-30[docs] binarycaching.md: Move Configuration section to the top. Add table ↵autoantwort
of… (#17060) * binarycaching.md: Move Configuration section to the top. Add table of contents. Make clear that file location must be absolute. Add that read is the default mode. * Apply suggestions from code review Co-authored-by: ras0219 <533828+ras0219@users.noreply.github.com> Co-authored-by: ras0219 <533828+ras0219@users.noreply.github.com>
2021-04-29[docs] Fix broken links (#17566)Phoebe
* [docs] Fix broken links * Fix the charactor * Update the charactor
2021-04-28[docs] Add mingw documentation (#17219)Kai Pastor
* Add mingw documentation * Minor edits * Fix typos * Revise comments about tools * Make mingw-w64 explicit * Fix another typo * How to avoid mixing different installations * Ban '/bin' from 'PATH', too * Update mingw.md Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-04-28Fix broken link (#17484)Kai Pastor
2021-03-29[docs-triplets] Suggest overlay triplets (#16867)Robert Schumacher
2021-03-29[docs] Vulkan SDK usage for Android triplets (#16881)Park DongHa
* [docs] Vulkan SDK usage for Android triplets * [docs] update links * redirect to developer.android.com for some keywords * Update docs/users/android.md Co-authored-by: Cheney Wang <38240633+Cheney-W@users.noreply.github.com> * [docs] add detailed path for libvulkan.so Co-authored-by: Cheney Wang <38240633+Cheney-W@users.noreply.github.com>
2021-03-11[docs] Improve inter-document linking; add 'latest' links (#16502)ras0219
* [docs] Improve inter-document linking; add 'latest' links * [docs] Apply suggestions from code review Co-authored-by: nicole mazzuca <mazzucan@outlook.com> Co-authored-by: nicole mazzuca <mazzucan@outlook.com> Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-03-10[docs/users/binarycaching.md] a little blurb about using GCS (#16337)Carlos O'Ryan
* [docs/users/binarycaching.md] a little blurb about using GCS * Address review comments * Small tweaks
2021-03-10[host dependencies] add support in the scripts (#16627)nicole mazzuca
This contains all the docs and scripts changes from #16479, without any of the ports changes, for easier CR
2021-02-26[docs] Add CMake Integration to manifests.md (#16323)ras0219
* [docs] Add CMake Integration to manifests.md * [docs] Add command line reference to manifests.md * Update docs/users/manifests.md Co-authored-by: Adam Johnson <AdamJohnso@gmail.com> Co-authored-by: Robert Schumacher <roschuma@microsoft.com> Co-authored-by: Adam Johnson <AdamJohnso@gmail.com>
2021-02-24[docs/users/manifests.md] add a link to the specification (#16336)Carlos O'Ryan
* [docs/users/manifests.md] add a link to the specification * Accept review suggestions Co-authored-by: NancyLi1013 <46708020+NancyLi1013@users.noreply.github.com> Co-authored-by: NancyLi1013 <46708020+NancyLi1013@users.noreply.github.com>
2021-02-20[vcpkg docs] Update the versioning.getting-started.md (#16324)Phoebe
2021-02-10[vcpkg integrate install] Allow setting the vcpkg installed dir (#16173)nicole mazzuca
* [vcpkg integrate install] Allow setting the vcpkg installed dir * fix the cache-y thing * robert crs
2021-02-09[vcpkg.targets] Add an additional options parameter for MSBuild integration ↵ras0219
(#16155) Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-02-09[docs/users/manifests.md] Prioritize examples. Fix example. Add MSBuild ↵Robert Schumacher
integration documentation. (#16069) * [docs/users/manifests.md] Prioritize examples. Fix example. Add MSBuild integration documentation. * Update docs/users/manifests.md Co-authored-by: nicole mazzuca <mazzucan@outlook.com> * Update docs/users/manifests.md Co-authored-by: nicole mazzuca <mazzucan@outlook.com> Co-authored-by: nicole mazzuca <mazzucan@outlook.com>
2021-02-08[vcpkg] More versioning docs (#15693)Victor Romero
* [vcpkg] Versioning docs: Getting started * Versioning docs: Getting started [revised] * Link to example of manifests in msbuild * [WIP] Reference docs * [vcpkg] Fix links in Getting Started with Versioning
2021-01-24[vcpkg] Allow to use Nuget's cache for Nuget binary caching sources (fix ↵Kevin Lalumiere
#15169) (#15512) * Fix warning on clang version 10.0.0-4ubuntu1 The warning was ```shell ../src/vcpkg/commands.porthistory.cpp:55:14: error: unused function 'is_date' [-Werror,-Wunused-function] ``` * Add environment variable VCPKG_USE_NUGET_CACHE As the name suggests, this environment variable allow tu use Nuget cache for Nuget binary caching sources. * Document NuGet's Cache environment variable
2021-01-15[vcpkg] Add initial versioning documentation (#15565)ras0219
* [vcpkg] Improve efficiency and tests of versioning * [vcpkg] Add initial versioning documentation and rename x-default-baseline to builtin-baseline * [vcpkg] Enable metrics for builtin-baseline & overrides * [vcpkg] Address PR comments * [vcpkg] Add support for syntax in version>= * [vcpkg] Remove port-version from dependency syntax * [vcpkg] Address CR comment * [vcpkg] Minor docs fixup
2021-01-05[vcpkg] Improve docs for binarycaching (#15396)ras0219
2020-12-17[vcpkg] `VCPKG_ENV_PASSTHROUGH_UNTRACKED` (#15115)ras0219
* [vcpkg] Add VCPKG_ENV_PASSTHROUGH_UNTRACKED * [vcpkg] CR comments Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2020-12-08[vcpkg] Fix uploading to Azure DevOps Artifacts (#14952)ras0219
2020-11-18[vcpkg] Add experimental x-azblob binary provider (#13626)ras0219
* [vcpkg] Add experimental x-azblob binary provider * [vcpkg] Test azblob storage provider in CI * [vcpkg] Address some CR comments from #13639 * [vcpkg] Fixup azure-pipelines * [vcpkg] Fix regression where the downloaded package is purged before decompressing * [vcpkg] Further refactor vcpkg::Downloads * [vcpkg] Enable OSX for x-azblob testing * [vcpkg] Reduce diff against master * [vcpkg] Extract Downloads::details::split_uri_view * [vcpkg] Address PR comments * [vcpkg] Add testing and metrics for x-azblob * [vcpkg] Add docs for x-azblob This includes a note that it is currently experimental * [vcpkg] Address CR comments * [vcpkg] Revert pipeline changes except OSX to minimize disruption Co-authored-by: Robert Schumacher <roschuma@microsoft.com> Co-authored-by: Billy Robert O'Neal III <bion@microsoft.com>
2020-11-02[vcpkg] User help: selecting-library-features.md (#14189)miheer vaidya
2020-10-12[vcpkg] Further JSON error improvements (#13399)ras0219
* [vcpkg] Split vcpkg/base/json.h into vcpkg/base/jsonreader.h * [vcpkg] Extract definitions of Configuration-Deserializer (& friends) These types are only used by VcpkgPaths during the initial parse. * [vcpkg] Introduce levenshtein-distance suggestions for json errors * [vcpkg] Fix regression in supports handling * [vcpkg] Fix signed/unsigned mismatch * [vcpkg] Address CR comments * [vcpkg] Address CR comments * Fix compiler error from merge conflict. * [vcpkg] Change parameters of Reader::check_for_unexpected_fields to better match declaration * [vcpkg] Improve errors from features set * [vcpkg] Fix includes * [vcpkg] Reuse code * [vcpkg] Check the "name" field always to maximize error information * [docs] Improve english phrasing in manifests.md * [vcpkg] Correct docs link for manifests Co-authored-by: Robert Schumacher <roschuma@microsoft.com> Co-authored-by: Billy Robert O'Neal III <bion@microsoft.com>
2020-09-28[vcpkg] add env var VCPKG_OVERLAY_TRIPLETS (#12790)Alexander Neumann
* [vcpkg] add env var VCPKG_OVERLAY_TRIPLETS * shorten way to complicated doc * run clang format * Apply CR Co-authored-by: ras0219 <533828+ras0219@users.noreply.github.com> * Apply CR2 Co-authored-by: nicole mazzuca <mazzucan@outlook.com> Co-authored-by: ras0219 <533828+ras0219@users.noreply.github.com> Co-authored-by: nicole mazzuca <mazzucan@outlook.com> Co-authored-by: Billy Robert O'Neal III <bion@microsoft.com> Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2020-09-27[vcpkg-docs] Add note about GitHub hosted agents (#13641)ras0219
* [vcpkg_docs] Add note about GitHub hosted agents * [vcpkg-docs] Add ./ prefixes to GitHub example Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2020-09-17[vcpkg_docs] Fix feature flags option typo (#13578)Rafael Rivera
2020-09-15[vcpkg-docs] Add docs/users/binarycaching.md (#13517)ras0219
* [vcpkg-docs] Add docs/users/binarycaching.md * [vcpkg] Address PR Comments Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2020-09-14[vcpkg manifest] Add documentation! (#13488)nicole mazzuca
* [vcpkg docs] add docs for manifest files These are just for the maintainer docs, not user docs. * [vcpkg] EBNF-ify platform expression parsing this modifies nothing about what strings are accepted or rejected, it just moves stuff around. also adds tests. * [vcpkg docs] add manifest mode example * [wip] docs for augustin also fix tabs * [vcpkg manifest] switch to using maps for features * Apply suggestions from code review * un-experimentize format-manifest * flesh out the user manifest mode docs * CRs * billy CRs * final personal pass-thru
2020-09-0311129: Add VCPKG_LINKER_FLAGS_<CONFIG>. (#11290)Paul
Co-authored-by: Nicole Mazzuca <mazzucan@outlook.com> Co-authored-by: JackBoosY <yuzaiyang@beyondsoft.com> Co-authored-by: Billy Robert O'Neal III <bion@microsoft.com>
2020-08-19Fix bullet lists for integration.md on readthedocs.io (#12873)Frank Theile
2020-08-05[vcpkg] add environment variable VCPKG_OVERLAY_PORTS (#12640)Alexander Neumann
* [vcpkg] add environment variable VCPKG_OVERLAY_PORTS * add documentation for VCPKG_OVERLAY_PORTS * append env overlay instead of prepending to give explicitly listed overlays priority * fix formating (manually) * manually fixing formating * improve help text Co-authored-by: ras0219 <533828+ras0219@users.noreply.github.com> Co-authored-by: ras0219 <533828+ras0219@users.noreply.github.com>