vcpkg/docs/maintainers/vcpkg_check_linkage.md
nicole mazzuca 6b117c9c7e
[vcpkg docs] Check for documentation generation in CI (#14614)
* [vcpkg docs] Change how documenting port functions works

Instead of using `##`, use comment blocks for documentation.

Also, add some minor docs and change RST -> MD
so we actually get docs generated.

* add CI stuff

* regenerate docs

* fix vcpkg_find_acquire_program to not use _execute_process
2020-12-01 13:37:26 -08:00

1.0 KiB

vcpkg_check_linkage

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.

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