summaryrefslogtreecommitdiff
path: root/codegen/vulkan/tests/README.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'codegen/vulkan/tests/README.adoc')
-rw-r--r--codegen/vulkan/tests/README.adoc22
1 files changed, 22 insertions, 0 deletions
diff --git a/codegen/vulkan/tests/README.adoc b/codegen/vulkan/tests/README.adoc
new file mode 100644
index 00000000..9d52d4d6
--- /dev/null
+++ b/codegen/vulkan/tests/README.adoc
@@ -0,0 +1,22 @@
+// Copyright 2017-2021 The Khronos Group Inc.
+//
+// SPDX-License-Identifier: CC-BY-4.0
+
+ifdef::env-github[]
+:note-caption: :information_source:
+endif::[]
+
+= Vulkan^(R)^ API Header Tests
+
+This directory contains simple compilation tests used by the CI script
+(../.gitlab-ci.yml) for the Vulkan C headers generated here, and the
+Vulkan-Hpp C++ headers generated by that project:
+
+[options="compact"]
+ * htest.c - test C headers, including all Vulkan platform headers
+ ** ggp_c/, wayland-client.h, windows.h, X11/, xcb/, zircon/, screen/ -
+ fake platform headers used when compiling in an environment without
+ the actual platform headers.
+ * hpptest.cpp - test C++ headers
+
+The 'make test' target in ../xml also builds the C header test.