diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/maintainers/control-files.md | 54 | ||||
| -rw-r--r-- | docs/users/triplets.md | 32 |
2 files changed, 68 insertions, 18 deletions
diff --git a/docs/maintainers/control-files.md b/docs/maintainers/control-files.md index a074a7ae2..87468e6af 100644 --- a/docs/maintainers/control-files.md +++ b/docs/maintainers/control-files.md @@ -8,7 +8,7 @@ Field names are case-sensitive and start the line without leading whitespace. P ## Source Paragraph -The first paragraph in a `CONTROL` file is the Source paragraph. It must have a `Source`, `Version`, and `Description` field. It can optionally have a `Build-Depends` and `Default-Features` field. +The first paragraph in a `CONTROL` file is the Source paragraph. It must have a `Source`, `Version`, and `Description` field. The full set of fields is documented below. ### Examples: ```no-highlight @@ -58,7 +58,7 @@ For example, given: Then if you update the source version today, you should give it version `2019-06-01`. If you need to make a change which doesn't adjust the source version, you should give it version `2019-02-14-2`. -Example: +##### Examples: ```no-highlight Version: 1.0.5-2 ``` @@ -71,7 +71,7 @@ A description of the library. By convention the first line of the description is a summary of the library. An optional detailed description follows. The detailed description can be multiple lines, all starting with whitespace. -Example: +##### Examples: ```no-highlight Description: C++ header-only JSON library ``` @@ -96,17 +96,13 @@ Vcpkg does not distinguish between build-only dependencies and runtime dependenc *For example: websocketpp is a header only library, and thus does not require any dependencies at install time. However, downstream users need boost and openssl to make use of the library. Therefore, websocketpp lists boost and openssl as dependencies* -Example: -```no-highlight -Build-Depends: zlib, libpng, libjpeg-turbo, tiff -``` -If the port is dependent on optional features of another library those can be specified using the `portname[featurelist]` syntax. +If the port is dependent on optional features of another library those can be specified using the `portname[featurelist]` syntax. If the port does not require any features from the dependency, this should be specifed as `portname[core]`. -Dependencies can be filtered based on the target triplet to support different requirements on Windows Desktop versus the Universal Windows Platform. Currently, the string inside parentheses is substring-compared against the triplet name. There must be a space between the name of the port and the filter. __This will change in a future version to not depend on the triplet name.__ +Dependencies can be filtered based on the target triplet to support differing requirements. These filters use the same syntax as the Supports field below and are surrounded in parentheses following the portname and feature list. -Example: +##### Example: ```no-highlight -Build-Depends: curl[openssl] (!windows&!osx), curl[winssl] (windows), curl[darwinssl] (osx) +Build-Depends: rapidjson, curl[core,openssl] (!windows), curl[core,winssl] (windows) ``` #### Default-Features @@ -114,10 +110,46 @@ Comma separated list of optional port features to install by default. This field is optional. +##### Example: ```no-highlight Default-Features: dynamodb, s3, kinesis ``` +<a name="Supports"></a> +#### Supports +Expression that evaluates to true when the port is expected to build successfully for a triplet. + +Currently, this field is only used in the CI testing to skip ports. In the future, this mechanism is intended to warn users in advance that a given install tree is not expected to succeed. Therefore, this field should be used optimistically; in cases where a port is expected to succeed 10% of the time, it should still be marked "supported". + +The grammar for the supports expression uses standard operators: +- `!expr` - negation +- `expr|expr` - or (`||` is also supported) +- `expr&expr` - and (`&&` is also supported) +- `(expr)` - grouping/precedence + +The predefined expressions are computed from standard triplet settings: +- `x64` - `VCPKG_TARGET_ARCHITECTURE` == `"x64"` +- `x86` - `VCPKG_TARGET_ARCHITECTURE` == `"x86"` +- `arm` - `VCPKG_TARGET_ARCHITECTURE` == `"arm"` or `VCPKG_TARGET_ARCHITECTURE` == `"arm64"` +- `arm64` - `VCPKG_TARGET_ARCHITECTURE` == `"arm64"` +- `windows` - `VCPKG_CMAKE_SYSTEM_NAME` == `""` or `VCPKG_CMAKE_SYSTEM_NAME` == `"WindowsStore"` +- `uwp` - `VCPKG_CMAKE_SYSTEM_NAME` == `"WindowsStore"` +- `linux` - `VCPKG_CMAKE_SYSTEM_NAME` == `"Linux"` +- `osx` - `VCPKG_CMAKE_SYSTEM_NAME` == `"Darwin"` +- `android` - `VCPKG_CMAKE_SYSTEM_NAME` == `"Android"` +- `static` - `VCPKG_LIBRARY_LINKAGE` == `"static"` + +These predefined expressions can be overridden in the triplet file via the [`VCPKG_DEP_INFO_OVERRIDE_VARS`](../users/triplets.md) option. + +This field is optional and defaults to true. + +> Implementers' Note: these terms are computed from the triplet via the `vcpkg_get_dep_info` mechanism. + +##### Example: +```no-highlight +Supports: !(uwp|arm) +``` + ## Feature Paragraphs Multiple optional features can be specified in the `CONTROL` files. It must have a `Feature` and `Description` field. It can optionally have a `Build-Depends` field. It must be separated from other paragraphs by one or more empty lines. diff --git a/docs/users/triplets.md b/docs/users/triplets.md index 6e52d347d..21dea5c31 100644 --- a/docs/users/triplets.md +++ b/docs/users/triplets.md @@ -2,20 +2,17 @@ Triplet is a standard term used in cross compiling as a way to completely capture the target environment (cpu, os, compiler, runtime, etc) in a single convenient name. -In Vcpkg, we use triplets to describe self-consistent builds of library sets. This means every library will be built using the same target cpu, OS, and compiler toolchain, but also CRT linkage and preferred library type. +In Vcpkg, we use triplets to describe an imaginary "target configuration set" for every library. Within a triplet, libraries are generally built with the same configuration, but it is not a requirement. For example, you could have one triplet that builds `openssl` statically and `zlib` dynamically, one that builds them both statically, and one that builds them both dynamically (all for the same target OS and architecture). A single build will consume files from a single triplet. We currently provide many triplets by default (run `vcpkg help triplet`). However, you can easily add your own by creating a new file in the `triplets\` directory. The new triplet will immediately be available for use in commands, such as `vcpkg install boost:x86-windows-custom`. To change the triplet used by your project, such as to enable static linking, see our [Integration Document](integration.md#triplet-selection). - ## Community triplets -Triplets contained in the `triplets\community` folder are not tested by continuous integration. - -These triplets contain configurations commonly requested by the community, but for which we lack the resources to properly test. +Triplets contained in the `triplets\community` folder are not tested by continuous integration, but are commonly requested by the community. -Port updates may break compatibility with community triplets, such regressions won't get caught by our testing pipelines. Because of this, community involvement is paramount! +Because we do not have continuous coverage, port updates may break compatibility with community triplets. Because of this, community involvement is paramount! We will gladly accept and review contributions that aim to solve issues with these triplets. @@ -23,7 +20,7 @@ We will gladly accept and review contributions that aim to solve issues with the Community Triplets are enabled by default, when using a community triplet a message like the following one will be printed during a package install: -```bash +```no-highlight -- Using community triplet x86-uwp. This triplet configuration is not guaranteed to succeed. -- [COMMUNITY] Loading triplet configuration from: D:\src\viromer\vcpkg\triplets\community\x86-uwp.cmake ``` @@ -78,8 +75,29 @@ This option also has forms for configuration-specific and C flags: - `VCPKG_C_FLAGS_DEBUG` - `VCPKG_C_FLAGS_RELEASE` +<a name="VCPKG_DEP_INFO_OVERRIDE_VARS"></a> +### VCPKG_DEP_INFO_OVERRIDE_VARS +Replaces the default computed list of triplet "Supports" terms. + +This option (if set) will override the default set of terms used for qualified dependency resolution and "Supports" field evaluation. + +See the [`Supports`](../maintainers/control-files.md#Supports) control file field documentation for more details. + +> Implementers' Note: this list is extracted via the `vcpkg_get_dep_info` mechanism. + ## Windows Variables +### VCPKG_ENV_PASSTHROUGH +Instructs vcpkg to allow additional environment variables into the build process. + +On Windows, vcpkg builds packages in a special clean environment that is isolated from the current command prompt to ensure build reliability and consistency. + +This triplet option can be set to a list of additional environment variables that will be added to the clean environment. + +See also the `vcpkg env` command for how you can inspect the precise environment that will be used. + +> Implementers' Note: this list is extracted via the `vcpkg_get_tags` mechanism. + <a name="VCPKG_VISUAL_STUDIO_PATH"></a> ### VCPKG_VISUAL_STUDIO_PATH Specifies the Visual Studio installation to use. |