eden-emu/Vulkan-Utility-Libraries
14
0
Fork 0
mirror of https://github.com/KhronosGroup/Vulkan-Utility-Libraries.git synced 2025-05-14 08:48:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Vulkan-Utility-Libraries/tests/README.md
Juan Ramos 6710b67cde Ensure all header files shipped have the vk_ prefix 
CI will fail now if we ship a .h / .hpp file that doesn't use
the correct prefix.

I also documented the precedent for this prefix and the existing
integration testing.
2023-09-08 12:47:09 -06:00

1.2 KiB
Raw Blame History

Library integration testing

In order to avoid disruption of downstream users. It's important to test how this repository is consumed.

  1. Self contained headers

It's easy to write header files that aren't self contained. By compiling a single source file that includes a single header we ensure a smooth experience for downstream users.

  1. Ensure C compatibility of C header files

It's VERY easy to write invalid C code. Especially for experience C++ programmers.

tests/find_package

Test find_package support. The intent is to ensure we properly install files.

Used by system/language package managers and the Vulkan SDK packaging.

tests/add_subdirectory

  1. Test add_subdirectory support

While we don't have to support add_subdirectory it is a common feature request for CMake projects.

  1. Ensure file name consistency of header files we install

All header files we ship will have the vk_ prefix

This convention was originally established in VulkanHeaders for files created by LunarG.

  • EX: vk_icd.h, vk_layer.h, vk_platform.h