Push Vulkan Base changes without doing a full spec update, to verify

Antora build in Github Actions.

Author: oddhack

.gitlab-ci.yml

@@ -120,6 +120,33 @@ vksc-generate:
     expire_in: 1 week
   allow_failure: true
 
+# Generate the vulkan base specification and generate any associated files (such as vulkan_base.h)
+vulkanbase-generate:
+  stage: build
+  script:
+    - NODE_PATH="/usr/lib/node_modules"
+    - export NODE_PATH
+    - VULKAN_API="vulkanbase"
+    - export VULKAN_API
+    # Build the actual spec (both chunked and single-page HTML), and other common targets
+    - ./makeSpec -clean -spec all -version vkb1.4 -genpath genvkb QUIET= -j${nproc} -Otarget manhtmlpages validusage styleguide registry chunked html
+    - ./makeSpec -clean -spec all -version vkc1.4 -genpath genvkc QUIET= -j${nproc} -Otarget manhtmlpages validusage styleguide registry chunked html
+    - ./makeSpec -clean -spec all -version vkg1.4 -genpath genvkg QUIET= -j${nproc} -Otarget manhtmlpages validusage styleguide registry chunked html
+    # Check consistency of internal xrefs and anchors in the output, now
+    # that an HTML output is available
+    #- make check-xrefs
+    # Build headers, for use by all later stages
+    - ( cd xml && make GENERATED=../genvkb install test GENOPTS="-feature VK_BASE_VERSION_1_0 -feature VK_BASE_VERSION_1_1 -feature VK_BASE_VERSION_1_2 -feature VK_BASE_VERSION_1_3 -feature VK_BASE_VERSION_1_4  -emitExtensions '^$$'" )
+    - ( cd xml && make GENERATED=../genvkc install test GENOPTS="-feature VK_BASE_VERSION_1_0 -feature VK_COMPUTE_VERSION_1_0 -feature VK_BASE_VERSION_1_1 -feature VK_COMPUTE_VERSION_1_1 -feature VK_BASE_VERSION_1_2 -feature VK_COMPUTE_VERSION_1_2 -feature VK_BASE_VERSION_1_3 -feature VK_COMPUTE_VERSION_1_3 -feature VK_BASE_VERSION_1_4 -feature VK_COMPUTE_VERSION_1_4 -emitExtensions '^$$'" )
+    - ( cd xml && make GENERATED=../genvkg install test GENOPTS="-feature VK_BASE_VERSION_1_0 -feature VK_COMPUTE_VERSION_1_0 -feature VK_GRAPHICS_VERSION_1_0 -feature VK_BASE_VERSION_1_1 -feature VK_COMPUTE_VERSION_1_1 -feature VK_GRAPHICS_VERSION_1_1 -feature VK_BASE_VERSION_1_2 -feature VK_COMPUTE_VERSION_1_2 -feature VK_GRAPHICS_VERSION_1_2 -feature VK_BASE_VERSION_1_3 -feature VK_COMPUTE_VERSION_1_3 -feature VK_GRAPHICS_VERSION_1_3 -feature VK_BASE_VERSION_1_4 -feature VK_COMPUTE_VERSION_1_4 -feature VK_GRAPHICS_VERSION_1_4 -emitExtensions '^$$'" )
+  artifacts:
+    when: always
+    paths:
+      - genvkb/
+      - genvkc/
+      - genvkg/
+    expire_in: 2 weeks
+  allow_failure: true
 
 # Generate the vulkan C++ header (vulkan.hpp)
 hpp-generate:

Makefile

@@ -33,7 +33,9 @@
 # default to 'vulkan'
 VULKAN_API ?= vulkan
 ifeq ($(VULKAN_API),vulkan)
-VERSIONS := VK_VERSION_1_0 VK_VERSION_1_1 VK_VERSION_1_2 VK_VERSION_1_3
+VERSIONS := VK_VERSION_1_0 VK_VERSION_1_1 VK_VERSION_1_2 VK_VERSION_1_3 VK_VERSION_1_4
+else ifeq ($(VULKAN_API),vulkanbase)
+VERSIONS := VK_BASE_VERSION_1_0 VK_BASE_VERSION_1_1 VK_BASE_VERSION_1_2 VK_BASE_VERSION_1_3 VK_BASE_VERSION_1_4
 else
 VERSIONS := VK_VERSION_1_0 VK_VERSION_1_1 VK_VERSION_1_2 VKSC_VERSION_1_0
 endif
@@ -159,16 +161,16 @@ SPECREVISION = 1.0.$(SCPATCHVERSION)
 BASEOPTS = -a baserevnumber="$(VKSPECREVISION)"
 else
 
-ifneq (,$(findstring VK_VERSION_1_4,$(VERSIONS)))
+ifneq (,$(findstring VK_BASE_VERSION_1_4,$(VERSIONS)))
 SPECMINOR = 4
 else
-ifneq (,$(findstring VK_VERSION_1_3,$(VERSIONS)))
+ifneq (,$(findstring VK_BASE_VERSION_1_3,$(VERSIONS)))
 SPECMINOR = 3
 else
-ifneq (,$(findstring VK_VERSION_1_2,$(VERSIONS)))
+ifneq (,$(findstring VK_BASE_VERSION_1_2,$(VERSIONS)))
 SPECMINOR = 2
 else
-ifneq (,$(findstring VK_VERSION_1_1,$(VERSIONS)))
+ifneq (,$(findstring VK_BASE_VERSION_1_1,$(VERSIONS)))
 SPECMINOR = 1
 else
 SPECMINOR = 0

appendices/VK_EXT_discard_rectangles.adoc

@@ -32,11 +32,11 @@ rejected if the fragment is within any of the operational discard rectangles
 
 These discard rectangles operate orthogonally to the existing scissor test
 functionality.
-ifdef::VK_VERSION_1_1,VK_KHR_device_group[]
+ifdef::VK_BASE_VERSION_1_1,VK_KHR_device_group[]
 The discard rectangles can be different for each physical device in a device
 group by specifying the device mask and setting discard rectangle dynamic
 state.
-endif::VK_VERSION_1_1,VK_KHR_device_group[]
+endif::VK_BASE_VERSION_1_1,VK_KHR_device_group[]
 
 Version 2 of this extension introduces new dynamic states
 ename:VK_DYNAMIC_STATE_DISCARD_RECTANGLE_ENABLE_EXT and

appendices/VK_KHR_spirv_1_4.adoc

@@ -59,12 +59,12 @@ API changes.
 Most new SPIR-V versions introduce optionally-required capabilities or have
 implementation-defined limits, and would need more API and specification
 changes specific to that version to make them available in Vulkan.
-ifdef::VK_VERSION_1_1[]
+ifdef::VK_COMPUTE_VERSION_1_1[]
 For example, to support the subgroup capabilities added in SPIR-V 1.3
 required introducing slink:VkPhysicalDeviceSubgroupProperties to allow
 querying the supported group operation categories, maximum supported
 subgroup size, etc.
-endif::VK_VERSION_1_1[]
+endif::VK_COMPUTE_VERSION_1_1[]
 While we could expose the parts of a new SPIR-V version that do not need
 accompanying changes generically, we will still end up writing extensions
 specific to each version for the remaining parts.

appendices/VK_KHR_synchronization2.adoc

@@ -73,10 +73,10 @@ Other miscellaneous changes include:
   * Relevant pipeline stage masks can now be specified as empty with the new
     ename:VK_PIPELINE_STAGE_NONE_KHR and ename:VK_PIPELINE_STAGE_2_NONE_KHR
     values.
-ifdef::VK_VERSION_1_2,VK_KHR_create_renderpass2[]
+ifdef::VK_GRAPHICS_VERSION_1_2,VK_KHR_create_renderpass2[]
   * slink:VkMemoryBarrier2KHR can be chained to slink:VkSubpassDependency2,
     overriding the original 32-bit stage and access masks.
-endif::VK_VERSION_1_2,VK_KHR_create_renderpass2[]
+endif::VK_GRAPHICS_VERSION_1_2,VK_KHR_create_renderpass2[]
 
 include::{generated}/interfaces/VK_KHR_synchronization2.adoc[]
 

appendices/boilerplate.adoc

@@ -208,6 +208,7 @@ API version using, for example, one of the dname:VK_API_VERSION_*_* values.
 include::{generated}/api/defines/VK_HEADER_VERSION_COMPLETE.adoc[]
 --
 
+ifdef::VK_BASE_VERSION_1_0[]
 ifndef::VKSC_VERSION_1_0[]
 [open,refpage='VK_API_VERSION',desc='Deprecated version number macro',type='defines']
 --
@@ -217,6 +218,7 @@ used.
 include::{generated}/api/defines/VK_API_VERSION.adoc[]
 --
 endif::VKSC_VERSION_1_0[]
+endif::VK_BASE_VERSION_1_0[]
 
 
 ==== Vulkan Handle Macros

appendices/compressedtex.adoc

@@ -127,7 +127,7 @@ chapter of the <<data-format,Khronos Data Format Specification>>.
 | ename:VK_FORMAT_ASTC_12x10_SRGB_BLOCK       ^|[eq]#12 {times} 10# ^|sRGB
 | ename:VK_FORMAT_ASTC_12x12_UNORM_BLOCK      ^|[eq]#12 {times} 12# ^|Linear LDR
 | ename:VK_FORMAT_ASTC_12x12_SRGB_BLOCK       ^|[eq]#12 {times} 12# ^|sRGB
-ifdef::VK_VERSION_1_3,VK_EXT_texture_compression_astc_hdr[]
+ifdef::VK_BASE_VERSION_1_3,VK_EXT_texture_compression_astc_hdr[]
 | ename:VK_FORMAT_ASTC_4x4_SFLOAT_BLOCK       ^|[eq]#4 {times} 4#   ^|HDR
 | ename:VK_FORMAT_ASTC_5x4_SFLOAT_BLOCK       ^|[eq]#5 {times} 4#   ^|HDR
 | ename:VK_FORMAT_ASTC_5x5_SFLOAT_BLOCK       ^|[eq]#5 {times} 5#   ^|HDR
@@ -142,17 +142,17 @@ ifdef::VK_VERSION_1_3,VK_EXT_texture_compression_astc_hdr[]
 | ename:VK_FORMAT_ASTC_10x10_SFLOAT_BLOCK     ^|[eq]#10 {times} 10# ^|HDR
 | ename:VK_FORMAT_ASTC_12x10_SFLOAT_BLOCK     ^|[eq]#12 {times} 10# ^|HDR
 | ename:VK_FORMAT_ASTC_12x12_SFLOAT_BLOCK     ^|[eq]#12 {times} 12# ^|HDR
-endif::VK_VERSION_1_3,VK_EXT_texture_compression_astc_hdr[]
+endif::VK_BASE_VERSION_1_3,VK_EXT_texture_compression_astc_hdr[]
 |====
 
-ifndef::VK_VERSION_1_3,VK_EXT_texture_compression_astc_hdr[]
+ifndef::VK_BASE_VERSION_1_3,VK_EXT_texture_compression_astc_hdr[]
 ASTC textures containing any HDR blocks should: not be passed into the API
 using an sRGB or UNORM texture format.
-endif::VK_VERSION_1_3,VK_EXT_texture_compression_astc_hdr[]
-ifdef::VK_VERSION_1_3,VK_EXT_texture_compression_astc_hdr[]
+endif::VK_BASE_VERSION_1_3,VK_EXT_texture_compression_astc_hdr[]
+ifdef::VK_BASE_VERSION_1_3,VK_EXT_texture_compression_astc_hdr[]
 ASTC textures containing HDR block encodings should: be passed to the API
 using an ASTC SFLOAT texture format.
-endif::VK_VERSION_1_3,VK_EXT_texture_compression_astc_hdr[]
+endif::VK_BASE_VERSION_1_3,VK_EXT_texture_compression_astc_hdr[]
 
 [NOTE]
 ====

appendices/deprecation.adoc

@@ -60,7 +60,7 @@ apiext:VK_KHR_maintenance5) and anything superseded by a new version of the
 same functionality (e.g. apiext:VK_KHR_synchronization2).
 ====
 
-ifdef::VK_VERSION_1_1[]
+ifdef::VK_BASE_VERSION_1_1[]
 [[deprecation-gpdp2]]
 === Physical Device Queries: Deprecation via version 2
 
@@ -75,7 +75,7 @@ used instead of flink:vkGetPhysicalDeviceFeatures.
 When enabling device features, slink:VkPhysicalDeviceFeatures2 should: be
 provided in the pname:pNext chain of slink:VkDeviceCreateInfo instead of
 using slink:VkDeviceCreateInfo::pNext:pEnabledFeatures.
-endif::VK_VERSION_1_1[]
+endif::VK_BASE_VERSION_1_1[]
 
 [[deprecation-version-macros]]
 === Version Macros: Deprecation via replacements including API variant
@@ -107,7 +107,7 @@ commands operating on that instance or any of its child objects.
 At the time of deprecation there were no known device-only layers and no
 compelling reason to create one.
 
-ifdef::VK_VERSION_1_2[]
+ifdef::VK_GRAPHICS_VERSION_1_2[]
 [[deprecation-renderpass2]]
 === Render Pass Functions: Deprecation via version 2
 
@@ -116,17 +116,17 @@ introduced new versions of several render pass functions.
 These provide the same functionality as the Vulkan 1.0 functionality but
 with greater extensibility.
 
-ifdef::VK_VERSION_1_4[]
+ifdef::VK_GRAPHICS_VERSION_1_4[]
 [NOTE]
 ====
 Render pass objects and all related commands are further
 <<deprecation-dynamicrendering, deprecated by dynamic rendering>> in Vulkan
 1.4.
 ====
-endif::VK_VERSION_1_4[]
-endif::VK_VERSION_1_2[]
+endif::VK_GRAPHICS_VERSION_1_4[]
+endif::VK_GRAPHICS_VERSION_1_2[]
 
-ifdef::VK_VERSION_1_4[]
+ifdef::VK_GRAPHICS_VERSION_1_4[]
 === [[deprecation-dynamicrendering]]Render Pass Objects: Deprecation via dynamic rendering
 
 In Vulkan 1.3, the apiext:VK_KHR_dynamic_rendering extension was promoted
@@ -155,5 +155,5 @@ unless/until replacements are created.
 Outside of vendor extensions, applications are advised to make use of
 flink:vkCmdBeginRendering and flink:vkCmdEndRendering to manage render
 passes from this API version onward.
-endif::VK_VERSION_1_4[]
+endif::VK_GRAPHICS_VERSION_1_4[]
 endif::VKSC_VERSION_1_0[]