Commit Graph

94 Commits

Author SHA1 Message Date
Robert Schumacher
36b6831d19
[docs] Initial addition of CLI Reference docs (#24754)
* [docs] Initial addition of CLI Reference docs

* PR comments round 1

* [docs] Fix manifests.md TOC

* [docs] Sort common options

* [docs] Apply PR comments
2022-05-27 09:34:11 -07:00
Robert Schumacher
292067a61d
[docs] Fix broken links and generate documentation for vcpkg-gn (#24764)
* [docs] Fix broken links. Add docs validation pipeline.

* [docs][regenerate.ps1] Do not require a README.md in helper ports

* [docs] Update validateDocs.yml to point to current main
2022-05-20 14:42:35 -07:00
Robert Schumacher
1e91cd3769
[docs] Remove out-of-date docs, improve header standardization. (#24456)
* Remove out-of-date docs, improve header standardization.

* PR scoping & comments
2022-05-18 14:25:13 -07:00
Robert Schumacher
8639e65b88
[docs] Split integration.md per Build System. (#24737)
* Split integration.md per Build System.

Centralize buildsystem configuration.

* PR comment
2022-05-17 17:12:53 -07:00
Dean
97298f2ede
[vcpkg] Update android usage documentation (#23690)
* [doc] triplet creation is not needed any more for android.

The metioned triplets are already commited on master branch. There is no need to create triplet files for android. This doc is kind of outdated. I tried without the triplet creation stelp and jsoncpp installation is successful.

* [doc] keep android triplet to ABI mapping table

Co-authored-by: Jonliu1993 <13720414433@163.com>
2022-04-11 09:05:48 -07:00
Petr Tichý
d699e78f84
[authentication.md] Add Jenkins section (#23226) 2022-02-24 15:09:06 -08:00
nicole mazzuca
94c43b8f60
[docs] document VCPKG_INSTALLED_DIR variable (#22695) 2022-02-03 19:20:23 -08:00
Robert Schumacher
c06dfc0ac2
[docs] Add Authoring-script-ports.md (#22396)
* [docs] Add Authoring-script-ports.md

* Address CR comments

* Update docs/maintainers/authoring-script-ports.md

Co-authored-by: nicole mazzuca <83086508+strega-nil-ms@users.noreply.github.com>

Co-authored-by: nicole mazzuca <83086508+strega-nil-ms@users.noreply.github.com>
2022-02-03 13:08:10 -08:00
Robert Schumacher
1a1f31ce26
[docs] Update docs with full release of manifests, registries, and versioning (#21929)
* [docs] Update docs with full release of manifests, registries, and versioning

* [docs] CR changes
2022-01-06 15:55:41 -08:00
ulfllorenz
1b664707c1
Minor documentation addition (#21771)
* Minor documentation addition

* Update triplets.md

Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-11-30 18:21:10 -08:00
autoantwort
d3fc4df133
[docs] Document VCPKG_BUILD_TYPE (#21469)
* [docs] Document `VCPKG_BUILD_TYPE`

* Update docs/users/triplets.md

Co-authored-by: NancyLi1013 <46708020+NancyLi1013@users.noreply.github.com>

Co-authored-by: NancyLi1013 <46708020+NancyLi1013@users.noreply.github.com>
2021-11-18 20:57:02 -08:00
Robert Schumacher
92e34ac254
[docs] Add authentication.md (#20990)
* [docs] Add docs/users/authentication.md

* edits

* Add link to README.md

* Address CR comments

* Fixup

Co-authored-by: Robert Schumacher <ras0219@outlook.com>
2021-11-15 09:33:53 -08:00
Billy O'Neal
33ced4f1c3
Add data lifecycle management to binary caching docs (#20733)
... as suggested by Robert @ras0219 / @ras0219-msft
2021-10-15 19:20:07 -07:00
autoantwort
b8f91d13f3
docs: You can use the msbuild interation with multiple triplets since #19767 (#20717) 2021-10-14 18:12:23 -07:00
Billy O'Neal
97e7ac8d74
[vcpkg] Repair msbuild damage and workaround the way we integrate on VS2015. (#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-09-02 12:33:21 -07:00
autoantwort
2777eada3f
[docs] improve integrate documentation (#19700)
* [docs] improve integrate documentation

* Small suggestions

Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-08-30 17:11:16 -07:00
Kevin Lalumiere
c13c218522
[vcpkg] Add triplet option VCPKG_NO_COMPILER_TRACKING (#17526) 2021-08-25 20:36:28 -07:00
autoantwort
6b24f0fa76
[docs] Improve assetcaching.md (#19625)
* Improve asset caching readme

* Update assetcaching.md

Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-08-17 17:33:44 -07:00
Billy O'Neal
5fd29d9350
Fix title capitalization from https://github.com/vcpkg/vcpkg.github.io/pull/54 (#19345) 2021-08-03 13:56:45 -07:00
Eric Kilmer
f7c83acf48
[docs] Describe nugettimeout option in binarycaching (#19084) 2021-07-23 13:35:23 -07:00
Victor Romero
3c82e1931e
[docs] More Getting Started fixes (#18970)
* Use valid commmit ID for baseline

* More doc fixes
2021-07-20 16:24:38 -07:00
Julian Xhokaxhiu
ae5b1cf41b
[binarycaching.md] Improve Azure DevOps example (#18807)
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-07-06 13:37:15 -07:00
autoantwort
876e67c26e
[vcpkg.cmake] PREPEND CMAKE_FIND_ROOT_PATH (#17336)
* [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-23 15:30:46 -07:00
pastdue
38d2893b30
Add VCPKG_MAKE_CONFIGURE_OPTIONS (that can be set in the triplet) (#18132)
* 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-08 09:50:09 -07:00
ras0219
8c497bb647
[vcpkg] Add experimental $X_VCPKG_ASSET_SOURCES for source caching (#13639)
* [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-04 16:48:26 -07:00
Mats Taraldsvik
9411ed741e
[docs] Updated list of off-by-default features (#18258) 2021-06-03 12:26:40 -07:00
Augustin Popa
ce6253b6f4
[Doc] Update binarycaching.md with clearer description (#18033)
* 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-26 10:28:37 -07:00
nicole mazzuca
a3db16a447
[native supports-expr] docs changes (#16971) 2021-05-21 13:14:02 -07:00
Kai Pastor
5a271a9290
[doc] Fix spelling errors (#17560)
* [doc] Fix spelling errors in docs

* [doc] Fix spelling errors in scripts

* Bump version

* x-add-version

* Fix another typo

* Rebuild
2021-05-09 10:48:42 -07:00
nicole mazzuca
6e80675573
[docs registries] Add reference documentation (#17672)
* 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-06 12:13:29 -07:00
Robert Schumacher
2924119c1e
[docs] Consolidate versioning documentation (#17580)
Co-authored-by: Robert Schumacher <ras0219@outlook.com>
2021-05-03 09:43:34 -07:00
autoantwort
44d94c2edb
[docs] binarycaching.md: Move Configuration section to the top. Add table 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-30 12:40:18 -07:00
Phoebe
713e3aeb3f
[docs] Fix broken links (#17566)
* [docs] Fix broken links

* Fix the charactor

* Update the charactor
2021-04-29 13:39:50 -07:00
Kai Pastor
6240751612
[docs] Add mingw documentation (#17219)
* 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-28 14:49:21 -07:00
Kai Pastor
99a179d84d
Fix broken link (#17484) 2021-04-28 13:52:32 -07:00
Robert Schumacher
0f1ca21567
[docs-triplets] Suggest overlay triplets (#16867) 2021-03-29 09:40:08 -07:00
Park DongHa
2b903edac3
[docs] Vulkan SDK usage for Android triplets (#16881)
* [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-29 09:30:34 -07:00
ras0219
75522bb1f2
[docs] Improve inter-document linking; add 'latest' links (#16502)
* [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-11 16:37:49 -08:00
Carlos O'Ryan
8010840071
[docs/users/binarycaching.md] a little blurb about using GCS (#16337)
* [docs/users/binarycaching.md] a little blurb about using GCS

* Address review comments

* Small tweaks
2021-03-10 19:34:12 -06:00
nicole mazzuca
fe2a6bb789
[host dependencies] add support in the scripts (#16627)
This contains all the docs and scripts changes from #16479,
without any of the ports changes, for easier CR
2021-03-10 15:33:16 -08:00
ras0219
45ae65fd93
[docs] Add CMake Integration to manifests.md (#16323)
* [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-26 13:10:37 -08:00
Carlos O'Ryan
a09f19c379
[docs/users/manifests.md] add a link to the specification (#16336)
* [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-24 13:55:16 -08:00
Phoebe
5c1731cf74
[vcpkg docs] Update the versioning.getting-started.md (#16324) 2021-02-20 21:17:04 -08:00
nicole mazzuca
8d7cd1d09e
[vcpkg integrate install] Allow setting the vcpkg installed dir (#16173)
* [vcpkg integrate install] Allow setting the vcpkg installed dir

* fix the cache-y thing

* robert crs
2021-02-10 16:22:33 -08:00
ras0219
4502f8ed68
[vcpkg.targets] Add an additional options parameter for MSBuild integration (#16155)
Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-02-09 15:35:06 -08:00
Robert Schumacher
50651b1680
[docs/users/manifests.md] Prioritize examples. Fix example. Add MSBuild 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-09 14:03:41 -08:00
Victor Romero
3187f09a3c
[vcpkg] More versioning docs (#15693)
* [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-02-08 12:03:37 -08:00
Kevin Lalumiere
f60b947e13
[vcpkg] Allow to use Nuget's cache for Nuget binary caching sources (fix #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-24 23:11:02 -08:00
ras0219
4f8fb510ba
[vcpkg] Add initial versioning documentation (#15565)
* [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-15 12:35:48 -08:00
ras0219
6b346462ba
[vcpkg] Improve docs for binarycaching (#15396) 2021-01-05 14:37:04 -08:00