aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorStefano Sinigardi <stesinigardi@hotmail.com>2021-01-17 04:26:38 +0100
committerGitHub <noreply@github.com>2021-01-16 19:26:38 -0800
commitf89336d703bf3ffd2aa4f832f214b42a11c7d044 (patch)
tree891f90e6a3e714c4af552984425a2987cfe0d352 /docs
parent31eda3e931f30a480d90eac5f5ffa9fa9944121d (diff)
downloadvcpkg-f89336d703bf3ffd2aa4f832f214b42a11c7d044.tar.gz
vcpkg-f89336d703bf3ffd2aa4f832f214b42a11c7d044.zip
[libarchive+tesseract+opencv] add missing libarchiveConfig.cmake, fix tesseract downstream and unblock opencv CI (#15089)
* [tesseract] add missing reference for downstream projects * [tesseract] restore ci, fix many regressions that are uncovered by that * Update ports/opencv2/CONTROL Co-authored-by: NancyLi1013 <46708020+NancyLi1013@users.noreply.github.com> * [opencv] fix regressions on uwp, accept failure on arm64 for now * Apply suggestions from code review Co-authored-by: NancyLi1013 <46708020+NancyLi1013@users.noreply.github.com> * [opencv4] allow failures on all arm windows targets, both win32 and uwp * adopts hints from #15180 * [libarchive] bump control version * [libarchive] use vcpkg-cmake-wrapper instead of a custom libarchiveConfig, since it is vcpkg-provided and not port-provided * enable features to be visible in parent scope * apply documentation fix from CI * [libarchive] remove unnecessary lines in portfile * fix regressions * Update ports/gdcm/CONTROL * use more compact logic syntax * add new versions to baseline Co-authored-by: NancyLi1013 <46708020+NancyLi1013@users.noreply.github.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/maintainers/vcpkg_check_features.md40
1 files changed, 20 insertions, 20 deletions
diff --git a/docs/maintainers/vcpkg_check_features.md b/docs/maintainers/vcpkg_check_features.md
index fcf313bfd..6024c2a02 100644
--- a/docs/maintainers/vcpkg_check_features.md
+++ b/docs/maintainers/vcpkg_check_features.md
@@ -4,7 +4,7 @@ Check if one or more features are a part of a package installation.
## Usage
```cmake
vcpkg_check_features(
- OUT_FEATURE_OPTIONS <FEATURE_OPTIONS>
+ OUT_FEATURE_OPTIONS <FEATURE_OPTIONS>
[FEATURES
<cuda> <WITH_CUDA>
[<opencv> <WITH_OPENCV>]
@@ -15,27 +15,27 @@ vcpkg_check_features(
...]
)
```
-`vcpkg_check_features()` accepts these parameters:
+`vcpkg_check_features()` accepts these parameters:
-* `OUT_FEATURE_OPTIONS`:
- An output variable, the function will clear the variable passed to `OUT_FEATURE_OPTIONS`
+* `OUT_FEATURE_OPTIONS`:
+ An output variable, the function will clear the variable passed to `OUT_FEATURE_OPTIONS`
and then set it to contain a list of option definitions (`-D<OPTION_NAME>=ON|OFF`).
-
+
This should be set to `FEATURE_OPTIONS` by convention.
-
-* `FEATURES`:
- A list of (`FEATURE_NAME`, `OPTION_NAME`) pairs.
- For each `FEATURE_NAME` a definition is added to `OUT_FEATURE_OPTIONS` in the form of:
-
+
+* `FEATURES`:
+ A list of (`FEATURE_NAME`, `OPTION_NAME`) pairs.
+ For each `FEATURE_NAME` a definition is added to `OUT_FEATURE_OPTIONS` in the form of:
+
* `-D<OPTION_NAME>=ON`, if a feature is specified for installation,
- * `-D<OPTION_NAME>=OFF`, otherwise.
+ * `-D<OPTION_NAME>=OFF`, otherwise.
+
+* `INVERTED_FEATURES`:
+ A list of (`FEATURE_NAME`, `OPTION_NAME`) pairs, uses reversed logic from `FEATURES`.
+ For each `FEATURE_NAME` a definition is added to `OUT_FEATURE_OPTIONS` in the form of:
-* `INVERTED_FEATURES`:
- A list of (`FEATURE_NAME`, `OPTION_NAME`) pairs, uses reversed logic from `FEATURES`.
- For each `FEATURE_NAME` a definition is added to `OUT_FEATURE_OPTIONS` in the form of:
-
* `-D<OPTION_NAME>=OFF`, if a feature is specified for installation,
- * `-D<OPTION_NAME>=ON`, otherwise.
+ * `-D<OPTION_NAME>=ON`, otherwise.
## Notes
@@ -44,8 +44,8 @@ The `FEATURES` name parameter can be omitted if no `INVERTED_FEATURES` are used.
At least one (`FEATURE_NAME`, `OPTION_NAME`) pair must be passed to the function call.
-Arguments passed to `FEATURES` and `INVERTED_FEATURES` are not validated to prevent duplication.
-If the same (`FEATURE_NAME`, `OPTION_NAME`) pair is passed to both lists,
+Arguments passed to `FEATURES` and `INVERTED_FEATURES` are not validated to prevent duplication.
+If the same (`FEATURE_NAME`, `OPTION_NAME`) pair is passed to both lists,
two conflicting definitions are added to `OUT_FEATURE_OPTIONS`.
@@ -113,7 +113,7 @@ vcpkg_configure_cmake(
# Expands to "-DWITH_CUDA=ON; -DBUILD_CUDA=ON; -DBUILD_GPU=ON"
${FEATURE_OPTIONS}
)
-```
+```
### Example 4: Use regular and inverted features
@@ -135,7 +135,7 @@ vcpkg_configure_cmake(
# Expands to "-DWITH_TBB=ON; -DROCKSDB_IGNORE_PACKAGE_TBB=OFF"
${FEATURE_OPTIONS}
)
-```
+```
## Examples in portfiles