mirror/vcpkg
1
0
Fork 0
mirror of https://github.com/microsoft/vcpkg.git synced 2024-12-25 12:07:50 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
698ca0211d
vcpkg/docs/users/config-environment.md

102 lines
4.4 KiB
Markdown
Raw Normal View History

[docs] Add config-environment.md
2018-12-13 01:22:16 +08:00
## Environment and Configuration
[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-12 08:37:49 +08:00
**The latest version of this documentation is available on [GitHub](https://github.com/Microsoft/vcpkg/tree/master/docs/users/config-environment.md).**
[docs] Add config-environment.md
2018-12-13 01:22:16 +08:00
### Environment Variables
#### VCPKG_DOWNLOADS
This environment variable can be set to an existing directory to use for storing downloads instead of the internal
`downloads/` directory. It should always be set to an absolute path.
#### VCPKG_FEATURE_FLAGS
This environment variable can be set to a comma-separated list of off-by-default features in vcpkg. These features are
subject to change without notice and should be considered highly unstable.
[docs] Remove out-of-date docs, improve header standardization. (#24456) * Remove out-of-date docs, improve header standardization. * PR scoping & comments
2022-05-19 05:25:13 +08:00
There are no off-by-default feature flags at this time.
[docs] Add config-environment.md
2018-12-13 01:22:16 +08:00
#### EDITOR
This environment variable can be set to the full path of an executable to be used for `vcpkg edit`. Please see
`vcpkg help edit` for command-specific help.
#### VCPKG_ROOT
This environment variable can be set to a directory to use as the root of the vcpkg instance. Note that mixing vcpkg
repo versions and executable versions can cause issues.
[vcpkg-docs] Replace reference to VCPKG_DEFAULT_VS_PATH with VCPKG_VISUAL_STUDIO_PATH
2019-02-26 05:25:27 +08:00
#### VCPKG_VISUAL_STUDIO_PATH
[docs] Add config-environment.md
2018-12-13 01:22:16 +08:00
This environment variable can be set to the full path to a Visual Studio instance on the machine. This Visual Studio instance
[docs] Fix broken links (#17566) * [docs] Fix broken links * Fix the charactor * Update the charactor
2021-04-30 04:39:50 +08:00
will be used if the triplet does not override it via the [`VCPKG_VISUAL_STUDIO_PATH`](triplets.md#VCPKG_VISUAL_STUDIO_PATH) triplet setting.
[docs] Add config-environment.md
2018-12-13 01:22:16 +08:00
Example: `D:\2017`
#### VCPKG_DEFAULT_TRIPLET
This environment variable can be set to a triplet name which will be used for unqualified triplet references in command lines.
[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-11 07:33:16 +08:00
#### VCPKG_DEFAULT_HOST_TRIPLET
[docs] Fix broken links (#17566) * [docs] Fix broken links * Fix the charactor * Update the charactor
2021-04-30 04:39:50 +08:00
This environment variable can be set to a triplet name which will be used for unqualified host port references in command lines and all host port references in dependency lists. See [the host-dependencies documentation](host-dependencies.md) for more information.
[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-11 07:33:16 +08:00
[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-06 02:21:42 +08:00
#### VCPKG_OVERLAY_PORTS
This environment variable allows users to override ports with alternate versions according to the
[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-11 07:33:16 +08:00
[ports overlay](../specifications/ports-overlay.md) specification. List paths to overlays using
[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-10 01:48:42 +08:00
the platform dependent PATH separator (Windows `;` | others `:`)
[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-06 02:21:42 +08:00
Example (Windows): `C:\custom-ports\boost;C:\custom-ports\sqlite3`
[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 22:51:16 +08:00
#### VCPKG_OVERLAY_TRIPLETS
This environment variable allows users to add directories to search for triplets.
[Example: overlay triplets](../examples/overlay-triplets-linux-dynamic.md).
[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-10 01:48:42 +08:00
List paths to overlays using the platform dependent PATH separator (Windows `;`, others `:`)
[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 22:51:16 +08:00
[docs] Add config-environment.md
2018-12-13 01:22:16 +08:00
#### VCPKG_FORCE_SYSTEM_BINARIES
This environment variable, if set, suppresses the downloading of CMake and Ninja and forces the use of the system binaries.
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-29 05:34:26 +08:00
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-16 02:27:18 +08:00
#### VCPKG_FORCE_DOWNLOADED_BINARIES
This environment variable, if set, ignores the use of the system binaries and will always download and use the version defined by vcpkg.
[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-06 02:21:42 +08:00
#### VCPKG_KEEP_ENV_VARS
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-29 05:34:26 +08:00
This environment variable can be set to a list of environment variables, separated by `;`, which will be propagated to
the build environment.
[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-16 01:33:53 +08:00
The values of the kept variables will not be tracked in package ABIs and will not cause rebuilds when they change. To
pass in environment variables that should cause rebuilds on change, see [`VCPKG_ENV_PASSTHROUGH`](triplets.md#VCPKG_ENV_PASSTHROUGH).
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-29 05:34:26 +08:00
Example: `FOO_SDK_DIR;BAR_SDK_DIR`
[vcpkg] Improve docs for binarycaching (#15396)
2021-01-06 06:37:04 +08:00
[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-17 06:51:42 +08:00
<a name="VCPKG_MAX_CONCURRENCY"></a>
[vcpkg] Improve docs for binarycaching (#15396)
2021-01-06 06:37:04 +08:00
#### VCPKG_MAX_CONCURRENCY
[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-17 06:51:42 +08:00
This environment variables limits the amount of concurrency used by underlying buildsystems. If unspecified, this defaults to logical cores + 1.
[vcpkg] Improve docs for binarycaching (#15396)
2021-01-06 06:37:04 +08:00
#### VCPKG_DEFAULT_BINARY_CACHE
[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-21 05:42:35 +08:00
This environment variable redirects the default location to store binary packages. See [Binary Caching](binarycaching.md#configuration) for more details.
[vcpkg] Improve docs for binarycaching (#15396)
2021-01-06 06:37:04 +08:00
#### VCPKG_BINARY_SOURCES
[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-21 05:42:35 +08:00
This environment variable adds or removes binary sources. See [Binary Caching](binarycaching.md#configuration) for more details.
[vcpkg] Improve docs for binarycaching (#15396)
2021-01-06 06:37:04 +08:00
#### VCPKG_NUGET_REPOSITORY
[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-21 05:42:35 +08:00
This environment variable changes the metadata of produced NuGet packages. See [Binary Caching](binarycaching.md#configuration) for more details.
[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-25 15:11:02 +08:00
#### VCPKG_USE_NUGET_CACHE
[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-21 05:42:35 +08:00
This environment variable allows using NuGet's cache for every nuget-based binary source. See [Binary Caching](binarycaching.md#nuget-provider-configuration) for more details.
[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-05 07:48:26 +08:00
#### X_VCPKG_ASSET_SOURCES
> Note: This is an experimental feature and may change or be removed at any time
This environment variable allows using a private mirror for all SHA512-tagged assets. See [Asset Caching](assetcaching.md) for more details.
Reference in New Issue Copy Permalink