aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authornicole mazzuca <mazzucan@outlook.com>2021-05-21 13:14:02 -0700
committerGitHub <noreply@github.com>2021-05-21 13:14:02 -0700
commita3db16a4475b963cacf0260068c497fb72c8f3c0 (patch)
treea834ed6b2be756e3d095e81efa40b26baa423106 /docs
parent49b67d9cb856424ff69f10e7721aec5299624268 (diff)
downloadvcpkg-a3db16a4475b963cacf0260068c497fb72c8f3c0.tar.gz
vcpkg-a3db16a4475b963cacf0260068c497fb72c8f3c0.zip
[native supports-expr] docs changes (#16971)
Diffstat (limited to 'docs')
-rw-r--r--docs/maintainers/control-files.md1
-rw-r--r--docs/maintainers/manifest-files.md4
-rw-r--r--docs/users/host-dependencies.md6
3 files changed, 10 insertions, 1 deletions
diff --git a/docs/maintainers/control-files.md b/docs/maintainers/control-files.md
index 41d8fd0ac..7064ad40e 100644
--- a/docs/maintainers/control-files.md
+++ b/docs/maintainers/control-files.md
@@ -138,6 +138,7 @@ The grammar for the supports expression uses standard operators:
- `(expr)` - grouping/precedence
The predefined expressions are computed from standard triplet settings:
+- `native` - `TARGET_TRIPLET` == `HOST_TRIPLET`
- `x64` - `VCPKG_TARGET_ARCHITECTURE` == `"x64"`
- `x86` - `VCPKG_TARGET_ARCHITECTURE` == `"x86"`
- `arm` - `VCPKG_TARGET_ARCHITECTURE` == `"arm"` or `VCPKG_TARGET_ARCHITECTURE` == `"arm64"`
diff --git a/docs/maintainers/manifest-files.md b/docs/maintainers/manifest-files.md
index 92fa23236..590edb245 100644
--- a/docs/maintainers/manifest-files.md
+++ b/docs/maintainers/manifest-files.md
@@ -370,7 +370,7 @@ platform-expression =
| platform-expression-and
| platform-expression-or ;
-platform-expression-identifier =
+platform-expression-identifier =
| identifier-character, { identifier-character }, optional-whitespace ;
platform-expression-simple =
@@ -396,6 +396,8 @@ Ands and ors are a list of `&` or `|` separated identifiers, negated expressions
One may not mix `&` and `|` without parentheses for grouping.
These predefined identifier expressions are computed from standard triplet settings:
+- `native` - `TARGET_TRIPLET` == `HOST_TRIPLET`;
+ useful for ports which depend on their own built binaries in their build.
- `x64` - `VCPKG_TARGET_ARCHITECTURE` == `"x64"`
- `x86` - `VCPKG_TARGET_ARCHITECTURE` == `"x86"`
- `arm` - `VCPKG_TARGET_ARCHITECTURE` == `"arm"` or `VCPKG_TARGET_ARCHITECTURE` == `"arm64"`
diff --git a/docs/users/host-dependencies.md b/docs/users/host-dependencies.md
index 061e21804..6521d28dd 100644
--- a/docs/users/host-dependencies.md
+++ b/docs/users/host-dependencies.md
@@ -57,3 +57,9 @@ else()
# This is a cross build
endif()
```
+
+## Host-only ports
+
+Some ports are host-only: script ports and tool ports are common examples.
+In this case, you can use the `"native"` supports expression to describe this.
+This supports expression is true when `TARGET_TRIPLET == HOST_TRIPLET`.