mirror of https://github.com/microsoft/vcpkg.git synced 2024-12-05 09:21:49 +08:00

[docs] Fix the automatically generated document URL (#16611 )

* [document] Fix the automatically generated document URL

* [docs] Format all documents

2021-03-10 11:56:07 -06:00

3.6 KiB

Raw Blame History

vcpkg_check_features

The latest version of this document lives in the vcpkg repo. Check if one or more features are a part of a package installation.

vcpkg_check_features(
    OUT_FEATURE_OPTIONS <out-var>
    [PREFIX <prefix>]
    [FEATURES
        [<feature-name> <feature-var>]...
        ]
    [INVERTED_FEATURES
        [<feature-name> <feature-var>]...
        ]
)

The <out-var> should be set to FEATURE_OPTIONS by convention.

vcpkg_check_features() will:

for each <feature-name> passed in FEATURES:
- if the feature is set, add -D<feature-var>=ON to <out-var>, and set <prefix>_<feature-var> to ON.
- if the feature is not set, add -D<feature-var>=OFF to <out-var>, and set <prefix>_<feature-var> to OFF.
for each <feature-name> passed in INVERTED_FEATURES:
- if the feature is set, add -D<feature-var>=OFF to <out-var>, and set <prefix>_<feature-var> to OFF.
- if the feature is not set, add -D<feature-var>=ON to <out-var>, and set <prefix>_<feature-var> to ON.

If <prefix> is not passed, then the feature vars set are simply <feature-var>, not _<feature-var>.

If INVERTED_FEATURES is not passed, then the FEATURES keyword is optional. This behavior is deprecated.

If the same <feature-var> is passed multiple times, then vcpkg_check_features will cause a fatal error, since that is a bug.

Examples

Example 1: Regular features

$ ./vcpkg install mimalloc[asm,secure]

# ports/mimalloc/portfile.cmake
vcpkg_check_features(OUT_FEATURE_OPTIONS FEATURE_OPTIONS
    FEATURES
        asm       MI_SEE_ASM
        override  MI_OVERRIDE
        secure    MI_SECURE
)

vcpkg_configure_cmake(
    SOURCE_PATH ${SOURCE_PATH}
    PREFER_NINJA
    OPTIONS
        # Expands to "-DMI_SEE_ASM=ON;-DMI_OVERRIDE=OFF;-DMI_SECURE=ON"
        ${FEATURE_OPTIONS}
)

Example 2: Inverted features

$ ./vcpkg install cpprestsdk[websockets]

# ports/cpprestsdk/portfile.cmake
vcpkg_check_features(
    INVERTED_FEATURES
        brotli      CPPREST_EXCLUDE_BROTLI
        websockets  CPPREST_EXCLUDE_WEBSOCKETS
)

vcpkg_configure_cmake(
    SOURCE_PATH ${SOURCE_PATH}
    PREFER_NINJA
    OPTIONS
        # Expands to "-DCPPREST_EXCLUDE_BROTLI=ON;-DCPPREST_EXCLUDE_WEBSOCKETS=OFF"
        ${FEATURE_OPTIONS}
)

Example 3: Set multiple options for same feature

$ ./vcpkg install pcl[cuda]

# ports/pcl/portfile.cmake
vcpkg_check_features(
    FEATURES
        cuda  WITH_CUDA
        cuda  BUILD_CUDA
        cuda  BUILD_GPU
)

vcpkg_configure_cmake(
    SOURCE_PATH ${SOURCE_PATH}
    PREFER_NINJA
    OPTIONS
        # Expands to "-DWITH_CUDA=ON;-DBUILD_CUDA=ON;-DBUILD_GPU=ON"
        ${FEATURE_OPTIONS}
)

Example 4: Use regular and inverted features

$ ./vcpkg install rocksdb[tbb]

# ports/rocksdb/portfile.cmake
vcpkg_check_features(
    FEATURES
        tbb   WITH_TBB
    INVERTED_FEATURES
        tbb   ROCKSDB_IGNORE_PACKAGE_TBB
)

vcpkg_configure_cmake(
    SOURCE_PATH ${SOURCE_PATH}
    PREFER_NINJA
    OPTIONS
        # Expands to "-DWITH_TBB=ON;-DROCKSDB_IGNORE_PACKAGE_TBB=OFF"
        ${FEATURE_OPTIONS}
)

Examples in portfiles

Source

scripts/cmake/vcpkg_check_features.cmake

3.6 KiB Raw Blame History