aboutsummaryrefslogtreecommitdiff
path: root/docs/specifications
AgeCommit message (Collapse)Author
2021-10-11Update manifests.md (#20598)Dmitriy Fishman
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-03-18[vcpkg docs] Modify manifest-root-dir as manifest-root in ↵NancyLi1013
specifications/manifests.md (#16760)
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-02-18[vcpkg] Add scripts tree extraction notes. (#16055)Billy O'Neal
Co-authored-by: nicole mazzuca <mazzucan@outlook.com>
2021-02-03[vcpkg registries] Registries: Take 2 (#13590)nicole mazzuca
* [vcpkg registries] Registries: Take 2 unfortunately without all the history because I really screwed up the git commands This RFC is the new state of the world with regard to our plan for registries; it is very different from the old RFC. It includes registry databases, which are how one describes the set of versions of ports that one has access to. It also includes the specification for git registries, and updates the specification for filesystem registries with these new registry databases. Since this RFC completely changes how registries work, the existing implementation will be broken. * update the registries RFC for modern design * remove bikeshedding
2021-01-21[vcpkg] Rename `port_versions` to `versions` (#15784)nicole mazzuca
2021-01-19fix wrong path in specifications/manifests.md (#15688)Alessandro Arcangeli
2021-01-16[vcpkg] RFC: Versioning (#11758)Victor Romero
* Initial commit of Versioning Specification * Add image for algorith example * Add image file * Address some PR comments * Apply suggestions from code review Co-authored-by: Yehezkel Bernat <yehezkelshb@gmail.com> Co-authored-by: Miro Knejp <miro@knejp.de> Co-authored-by: Rachel Lu <lurachel18@gmail.com> * Update spec * Modify how baseline versions work * Add implementation details spec * WIP: Update specs to reflect latest discussions * Maybe fix formatting on GitHub preview * Apply suggestions from code review Co-authored-by: ras0219 <533828+ras0219@users.noreply.github.com> * Update spec * Update spec, match implementation * Delete unnecessary files Co-authored-by: Yehezkel Bernat <yehezkelshb@gmail.com> Co-authored-by: Miro Knejp <miro@knejp.de> Co-authored-by: Rachel Lu <lurachel18@gmail.com> Co-authored-by: Billy Robert O'Neal III <bion@microsoft.com> Co-authored-by: ras0219 <533828+ras0219@users.noreply.github.com>
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-02[vcpkg RFC] initial registries RFC (#12881)nicole mazzuca
2020-07-14[vcpkg] RFC: Binarycaching (#11204)Robert Schumacher
* [vcpkg] Initial commit of Binarycaching specification * [vcpkg] Update to Binarycaching Specification Note change to XDG directory structure. Replace 'upload' config keyword with more flexible read/write/readwrite keywords. * [vcpkg] Update binarycaching.md with new option --write-nuget-packages-config
2020-06-30[vcpkg manifest] Manifest Implementation (#11757)nicole mazzuca
==== Changes Related to manifests ==== * Add the `manifests` feature flag * This only says whether we look for a `vcpkg.json` in the cwd, not whether we support parsing manifests (for ports, for example) * Changes to the manifests RFC * `"authors"` -> `"maintainers"` * `--x-classic-mode` -> `-manifests` \in `vcpkg_feature_flags` * reserve `"core"` in addition to `"default"`, since that's already reserved for features * Add a small helper note about what identifiers must look like * `<license-string>`: SPDX v3.8 -> v3.9 * `"feature"."description"` is allowed to be an array of strings as well * `"version"` -> `"version-string"` for forward-compat with versions RFC * Add the `--feature-flags` option * Add the ability to turn off feature flags via passing `-<feature-flag>` to `VCPKG_FEATURE_FLAGS` or `--feature-flags` * Add CMake toolchain support for manifests * Requires either: * a feature flag of `manifests` in either `Env{VCPKG_FEATURE_FLAGS}` or `VCPKG_FEATURE_FLAGS` * Passing the `VCPKG_ENABLE_MANIFESTS` option * The toolchain will install your packages to `${VCPKG_MANIFEST_DIR}/vcpkg_installed`. * Add MSBuild `vcpkg integrate install` support for manifests * Requires `VcpkgEnableManifest` to be true * `vcpkg create` creates a port that has a `vcpkg.json` instead of a `CONTROL` * argparse, abseil, 3fd, and avisynthplus ports switched to manifest from CONTROL * Add support for `--x-manifest-root`, as well as code for finding it if not passed * Add support for parsing manifests! * Add a filesystem lock! ==== Important Changes which are somewhat unrelated to manifests ==== * Rename `logicexpression.{h,cpp}` to `platform-expression.{h,cpp}` * Add `PlatformExpression` type which takes the place of the old logic expression * Split the parsing of platform expressions from checking whether they're true or not * Eagerly parse PlatformExpressions as opposed to leaving them as strings * Add checking for feature flag consistency * i.e., if `-binarycaching` is passed, you shouldn't be passing `--binarysource` * Add the `Json::Reader` type which, with the help of user-defined visitors, converts JSON to your internal type * VcpkgArgParser: place the switch names into a constant as opposed to using magic constants * In general update the parsing code so that this ^ works * Add `Port-Version` fields to CONTROL files * This replaces the existing practice of `Version: <my-version>-<port-version>` ==== Smaller changes ==== * small drive-by cleanups to some CMake * `${_VCPKG_INSTALLED_DIR}/${VCPKG_TARGET_TRIPLET}` -> `${CURRENT_INSTALLED_DIR}` * Remove `-analyze` when compiling with clang-cl, since that's not a supported flag (vcpkg's build system) * Add a message about which compiler is detected by vcpkg's build system machinery * Fix `Expected::then` * Convert `""` to `{}` for `std::string` and `fs::path`, to avoid a `strlen` (additionally, `.empty()` instead of `== ""`, and `.clear()`) * Add `Strings::strto` which converts strings to numeric types * Support built-in arrays and `StringView` for `Strings::join` * Add `operator<` and friends to `StringView` * Add `substr` to `StringView` * SourceParagraphParser gets some new errors
2020-06-01[vcpkg] RFC: Manifests (#11203)nicole mazzuca
* [vcpkg] Add manifests specification * Remove invisible tabs and fix nested lists Somehow, a lot of tabs where inserted betweend the `*` and start of list items, and they didn't show up in the github source view 🤷. * feedback from @traversaro * fix stuff from review Co-authored-by: Edhebi <aurore53000@gmail.com>
2020-05-13[vcpkg] Improve Android doc (triplets, usage with cmake and prefab) (#11264)Pascal Thomet
* Android: add docs/examples/vcpkg_android_example_cmake/ * Add docs/users/android.md * Improve Android prefab doc Following additional informations given by @atkawa7 at https://github.com/microsoft/vcpkg/pull/11264 * Link to android.md * Update the prefab usage instructions: "vcpkg install" the 4 archs before exporting a prefab * added --prefab-debug flag * added gradle integration info * reviewed the prefab output directory structure (from a dump of an actual export) * docs/users/triplets.md: link to android.md * docs/index.md: link to android.md * android.md: specify 2 possibiities for android_ndk_home * Added examples/vcpkg_android_example_cmake_script/cmake/vcpkg_android.cmake Usage: 1. Main CMakeLists: if (VCPKG_TARGET_ANDROID) include("cmake/vcpkg_android.cmake") endif() 2. cmake invocation: cmake .. -DVCPKG_TARGET_ANDROID=ON -DANDROID_ABI=armeabi-v7a * trigger pipeline build * trigger pipelines
2020-04-06Android Support: Exporting to Android Archive (AAR) (#10271)atkawa7
* added android triplets * added android support to vcpkg * added export directories to git ignore * fix libraries naming * added vckpg sources to visual studio project files * rename file location * issue with std::string fs:path copy initialization * format path on VStudio * fix checks format cannot work on fs::path * support header only libraries * support using architecture instead of triplets * added prefab support * added debug logs and prefab debug flag * added support for empty packages i.e openssl
2019-06-27Update ports-overlay.mdVictor Romero
2019-06-21Ports Overlay partial implementation (#6981)Victor Romero
* Ports Overlay feature spec * Ports Overlay implementation * [--overlay-ports] Refactor handling of additional paths * Code cleanup * [--overlay-ports] Add help * [depend-info] Support --overlay-ports * Add method to load all ports using PathsPortFileProvider * Make PortFileProvider::load_all_control_files() const * Remove unused code * [vcpkg] Avoid double-load of source control file between Build::perform_and_exit and Build::perform_and_exit_ex * [vcpkg] Clang format * [vcpkg] Fixup build failure introduced in b069ceb2f231 * Report errors from Paragraphs::try_load_port()
2019-03-10Fix minor spelling mistakes in documentation (#5620)Bo Rydberg
2018-01-22[vcpkg-docs] Add feature packages to core documentation of CONTROL filesRobert Schumacher
2017-05-31[vcpkg-specs] Initial commit of Feature Packages draftRobert Schumacher
2017-05-28[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and ↵Robert Schumacher
MkDocs.