Commit Graph

26 Commits

Author SHA1 Message Date
Victor Romero
54cc53c434
[docs] Add stubs to redirect to Microsoft Learn (#29820) 2023-02-23 17:11:56 -08:00
Robert Schumacher
547c030e68
[vcpkg docs] Remove docs migrated to https://learn.microsoft.com/vcpkg and Microsoft/vcpkg-docs (#28350)
* [docs] Remove embedded documentation in favor of learn.microsoft.com

* [docs] Remove validation workflow
2023-02-16 11:36:51 -08:00
Billy O'Neal
b12e71232e
[vcpkg docs] Delete old schema file (#28187)
* Delete old schema file that has been replaced with https://raw.githubusercontent.com/microsoft/vcpkg-tool/main/docs/vcpkg.schema.json

This caused confusion for @Nekko in Discord here: https://discordapp.com/channels/400588936151433218/687365466422902841/1048988171393835099

* Also fix the one docs use pointed out by @autoantwort.
2022-12-12 14:38:01 -08:00
val
f7a537d6be
[docs] Document overlay ports/triplets in vcpkg-configuration.json (#27172)
* Update registries.md

* fixed typo

* fixed typo

* fixed wording and added link to spec

* explaining port resolution

* changed wording

* Victor's suggestion

Co-authored-by: Victor Romero <romerosanchezv@gmail.com>

* Added documentation on embedding configuration in manifest

* fixed path example

* typo

* Added info on paths accepted by overlays configured on the manifest

* changed example of absolute path to relative

* Changed wording according to comments

* fixed link to triplets doc

* Update docs/users/manifests.md

Co-authored-by: Victor Romero <romerosanchezv@gmail.com>

* Format of registries documentation

Co-authored-by: Valeria Conde <t-vconde@microsoft.com>
Co-authored-by: Victor Romero <romerosanchezv@gmail.com>
2022-11-11 12:54:00 -08:00
Robert Schumacher
c5ca6fd46b
[docs] Fix issues encountered during publishing 2022-09-01 (#26794)
* [docs] Document 'host' field in manifests

* [docs] Assorted fixes found while regenerating website

* Update docs/users/manifests.md

Co-authored-by: Victor Romero <romerosanchezv@gmail.com>
2022-09-23 12:30:43 -07:00
Robert Schumacher
59aa3a9eec
[docs] Add documentation for x-update-baseline (#25256) 2022-06-23 14:59:09 -07:00
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
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
nicole mazzuca
94c43b8f60
[docs] document VCPKG_INSTALLED_DIR variable (#22695) 2022-02-03 19:20:23 -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
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
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
Robert Schumacher
2924119c1e
[docs] Consolidate versioning documentation (#17580)
Co-authored-by: Robert Schumacher <ras0219@outlook.com>
2021-05-03 09:43: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
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
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
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
d1ba685e97
[vcpkg] Further JSON error improvements (#13399)
* [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-10-12 10:22:47 -07:00
Rafael Rivera
9c605a5efe
[vcpkg_docs] Fix feature flags option typo (#13578) 2020-09-17 13:10:02 -07:00
nicole mazzuca
0fec1340eb
[vcpkg manifest] Add documentation! (#13488)
* [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-14 15:07:02 -07:00