Commit Graph

22 Commits

Author SHA1 Message Date
Victor Romero
929fc61671
Document environment variable (#27000) 2022-10-13 17:12:51 -07:00
Billy O'Neal
0948fa8a1e
Add documentation of https://github.com/microsoft/vcpkg-tool/pull/725 (#27188)
* Add documentation of https://github.com/microsoft/vcpkg-tool/pull/725

* Fix @Neumann-A's feedback
2022-10-13 17:12:26 -07:00
Robert Schumacher
23cc58477e
[docs] Rewrite docs for vcpkg_cmake_build and vcpkg_cmake_install (#25477)
* [docs] Rewrite docs for vcpkg_cmake_build and vcpkg_cmake_install

* [docs] Fix broken links

* [docs] Add notes about parent helper port
2022-08-16 15:51:42 -07:00
Christophe Calmejane
aa01a5e13f
Added documentation for VCPKG_FORCE_DOWNLOADED_BINARIES env var (#24674)
See https://github.com/microsoft/vcpkg-tool/pull/138

Co-authored-by: Christophe Calmejane <dakikifr@free.fr>
Co-authored-by: Billy Robert O'Neal III <bion@microsoft.com>
2022-06-15 11:27:18 -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
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
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
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
Robert Schumacher
2924119c1e
[docs] Consolidate versioning documentation (#17580)
Co-authored-by: Robert Schumacher <ras0219@outlook.com>
2021-05-03 09:43:34 -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
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
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
6b346462ba
[vcpkg] Improve docs for binarycaching (#15396) 2021-01-05 14:37:04 -08:00
Alexander Neumann
0c1c43742d
[vcpkg] add env var VCPKG_OVERLAY_TRIPLETS (#12790)
* [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-28 07:51:16 -07:00
Alexander Neumann
4fb846bd44
[vcpkg] add environment variable VCPKG_OVERLAY_PORTS (#12640)
* [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>
2020-08-05 11:21:42 -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
Don
d71ad4800b Allow additional environment variables to be set in a clean environment (#5650)
* Allow additional environment variables to be set in a clean environment

* Add documentation for VCPKG_KEEP_ENV_VARS
2019-03-28 14:34:26 -07:00
Robert Schumacher
9ef92a21a0 [vcpkg-docs] Replace reference to VCPKG_DEFAULT_VS_PATH with VCPKG_VISUAL_STUDIO_PATH 2019-02-25 13:25:27 -08:00
Robert Schumacher
1d5e22919f [docs] Add config-environment.md 2018-12-12 09:22:16 -08:00