vcpkg/docs/maintainers/vcpkg_check_linkage.md
Jack·Boos·Yu 2b20b27b0d
[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

1.3 KiB

vcpkg_check_linkage

The latest version of this document lives in the vcpkg repo.

Asserts the available library and CRT linkage options for the port.

Usage

vcpkg_check_linkage(
    [ONLY_STATIC_LIBRARY | ONLY_DYNAMIC_LIBRARY]
    [ONLY_STATIC_CRT | ONLY_DYNAMIC_CRT]
)

Parameters

ONLY_STATIC_LIBRARY

Indicates that this port can only be built with static library linkage.

Note: If the user requested a dynamic build ONLY_STATIC_LIBRARY will result in a note being printed, not a fatal error.

ONLY_DYNAMIC_LIBRARY

Indicates that this port can only be built with dynamic/shared library linkage.

ONLY_STATIC_CRT

Indicates that this port can only be built with static CRT linkage.

ONLY_DYNAMIC_CRT

Indicates that this port can only be built with dynamic/shared CRT linkage.

Notes

This command will either alter the settings for VCPKG_LIBRARY_LINKAGE or fail, depending on what was requested by the user versus what the library supports.

Examples

Source

scripts/cmake/vcpkg_check_linkage.cmake