23 Commits

Author SHA1 Message Date
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
Dmitriy Fishman
b4c00cb0e3
Update manifests.md (#20598) 2021-10-11 17:22:32 -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
NancyLi1013
1eca0d23cd
[vcpkg docs] Modify manifest-root-dir as manifest-root in specifications/manifests.md (#16760) 2021-03-18 13:19:51 -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
Billy O'Neal
5dbf58d96d
[vcpkg] Add scripts tree extraction notes. (#16055)
Co-authored-by: nicole mazzuca <mazzucan@outlook.com>
2021-02-18 14:10:41 -08:00
nicole mazzuca
f226416d2e
[vcpkg registries] Registries: Take 2 (#13590)
* [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-02-03 14:44:43 -08:00
nicole mazzuca
68a74950d0
[vcpkg] Rename port_versions to versions (#15784) 2021-01-21 09:53:22 -08:00
Alessandro Arcangeli
a9a636c1a6
fix wrong path in specifications/manifests.md (#15688) 2021-01-19 00:45:07 -08:00
Victor Romero
31eda3e931
[vcpkg] RFC: Versioning (#11758)
* 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>
2021-01-16 16:38:46 -08:00
ras0219
54a09ff4ef
[vcpkg-docs] Add docs/users/binarycaching.md (#13517)
* [vcpkg-docs] Add docs/users/binarycaching.md

* [vcpkg] Address PR Comments

Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2020-09-15 18:04:12 -07:00
nicole mazzuca
d73ead568b
[vcpkg RFC] initial registries RFC (#12881) 2020-09-02 09:14:24 -07:00
Robert Schumacher
f38a61de33
[vcpkg] RFC: Binarycaching (#11204)
* [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-07-14 08:36:01 -07:00
nicole mazzuca
1d8f0acc9c
[vcpkg manifest] Manifest Implementation (#11757)
==== 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-30 10:40:18 -07:00
nicole mazzuca
1ffc953ab5
[vcpkg] RFC: Manifests (#11203)
* [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-06-01 11:30:56 -07:00
Pascal Thomet
55be137d5b
[vcpkg] Improve Android doc (triplets, usage with cmake and prefab) (#11264)
* 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-05-13 16:42:13 -07:00
atkawa7
52b5dfd2ef
Android Support: Exporting to Android Archive (AAR) (#10271)
* 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
2020-04-06 14:36:17 -07:00
Victor Romero
53a02456a0
Update ports-overlay.md 2019-06-27 16:32:38 -07:00
Victor Romero
f3db66b403
Ports Overlay partial implementation (#6981)
* 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-06-21 23:50:05 -07:00
Bo Rydberg
c247a7d21f Fix minor spelling mistakes in documentation (#5620) 2019-03-10 20:31:02 -07:00
Robert Schumacher
77eae92e75 [vcpkg-docs] Add feature packages to core documentation of CONTROL files 2018-01-22 22:28:13 -08:00
Robert Schumacher
d8791515cc [vcpkg-specs] Initial commit of Feature Packages draft 2017-05-31 16:53:05 -07:00
Robert Schumacher
49cd399586 [vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-28 14:15:13 -07:00