diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/maintainers/vcpkg_check_features.md | 40 |
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 |