diff options
| author | Mikhaylov Anton <anion155@gmail.com> | 2020-02-04 13:40:15 +0500 |
|---|---|---|
| committer | Mikhaylov Anton <anion155@gmail.com> | 2020-02-04 13:40:15 +0500 |
| commit | d56ed7ee7613e969a3f304b3377438cc5a9064d4 (patch) | |
| tree | d352eee837443f070bbf5d6c5fdd9a6f22f4f8c2 /docs/maintainers | |
| parent | ab5b74c797f5a2bd6b28915908355e2b32876dfa (diff) | |
| parent | 85bf9d9d792e379e973d66c8af9f39d65d1d6d42 (diff) | |
| download | vcpkg-d56ed7ee7613e969a3f304b3377438cc5a9064d4.tar.gz vcpkg-d56ed7ee7613e969a3f304b3377438cc5a9064d4.zip | |
Merge branch 'master' into patch-1
Diffstat (limited to 'docs/maintainers')
| -rw-r--r-- | docs/maintainers/control-files.md | 54 |
1 files changed, 43 insertions, 11 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. |
