Update for Vulkan-Docs 1.2.141

2020-05-15 04:54:44 -07:00
parent 9250d5ae8f
commit 09531f2793
7 changed files with 173 additions and 70 deletions
--- a/registry/genvk.py
+++ b/registry/genvk.py
@@ -166,12 +166,13 @@ def makeGenOpts(args):
            expandEnumerants  = False)
        ]

-    # API names to validate man/api spec includes & links
-    genOpts['vkapi.py'] = [
+    # Python representation of API information, used by scripts that
+    # don't need to load the full XML.
+    genOpts['api.py'] = [
          PyOutputGenerator,
          DocGeneratorOptions(
            conventions       = conventions,
-            filename          = 'vkapi.py',
+            filename          = 'api.py',
            directory         = directory,
            apiname           = 'vulkan',
            profile           = None,
@@ -180,7 +181,8 @@ def makeGenOpts(args):
            defaultExtensions = None,
            addExtensions     = addExtensionsPat,
            removeExtensions  = removeExtensionsPat,
-            emitExtensions    = emitExtensionsPat)
+            emitExtensions    = emitExtensionsPat,
+            reparentEnums     = False)
        ]

    # API validity files for spec
--- a/registry/reg.py
+++ b/registry/reg.py
@@ -23,6 +23,16 @@ from collections import defaultdict, namedtuple
 from generator import OutputGenerator, GeneratorOptions, write


+def apiNameMatch(str, supported):
+    """Return whether a required api name matches a pattern specified for an
+    XML <feature> 'api' attribute or <extension> 'supported' attribute.
+
+    - str - api name such as 'vulkan' or 'openxr'
+    - supported - comma-separated list of XML API names"""
+
+    return (str is not None and str in supported.split(','))
+
+
 def matchAPIProfile(api, profile, elem):
    """Return whether an API and profile
    being generated matches an element's profile
@@ -1154,7 +1164,7 @@ class Registry:
        for key in self.apidict:
            fi = self.apidict[key]
            api = fi.elem.get('api')
-            if api == self.genOpts.apiname:
+            if apiNameMatch(self.genOpts.apiname, api):
                apiMatch = True
                if regVersions.match(fi.name):
                    # Matches API & version #s being generated. Mark for
@@ -1191,13 +1201,10 @@ class Registry:
            extName = ei.name
            include = False

-            # Include extension if defaultExtensions is not None and if the
-            # 'supported' attribute matches defaultExtensions. The regexp in
-            # 'supported' must exactly match defaultExtensions, so bracket
-            # it with ^(pat)$.
-            pat = '^(' + ei.elem.get('supported') + ')$'
-            if (self.genOpts.defaultExtensions
-                    and re.match(pat, self.genOpts.defaultExtensions)):
+            # Include extension if defaultExtensions is not None and is
+            # exactly matched by the 'supported' attribute.
+            if apiNameMatch(self.genOpts.defaultExtensions,
+                            ei.elem.get('supported')):
                self.gen.logMsg('diag', 'Including extension',
                                extName, "(defaultExtensions matches the 'supported' attribute)")
                include = True
--- a/registry/validusage.json
+++ b/registry/validusage.json
@@ -1,9 +1,9 @@
 {
  "version info": {
    "schema version": 2,
-    "api version": "1.2.140",
-    "comment": "from git branch: github-master commit: a79b923ed376c42e99ecdb9d2ad69a56fb850ddc",
-    "date": "2020-05-04 09:48:50Z"
+    "api version": "1.2.141",
+    "comment": "from git branch: github-master commit: 8bd1271c25ec56248494389b0cc2b6741cb28164",
+    "date": "2020-05-15 09:13:21Z"
  },
  "validation": {
    "vkGetInstanceProcAddr": {
@@ -7932,9 +7932,13 @@
    },
    "vkGetRayTracingShaderGroupHandlesKHR": {
      "(VK_NV_ray_tracing,VK_KHR_ray_tracing)": [
+        {
+          "vuid": "VUID-vkGetRayTracingShaderGroupHandlesKHR-firstGroup-04050",
+          "text": " <code>firstGroup</code> <strong class=\"purple\">must</strong> be less than the number of shader groups in <code>pipeline</code>"
+        },
        {
          "vuid": "VUID-vkGetRayTracingShaderGroupHandlesKHR-firstGroup-02419",
-          "text": " The sum of <code>firstGroup</code> and <code>groupCount</code> <strong class=\"purple\">must</strong> be less than the number of shader groups in <code>pipeline</code>"
+          "text": " The sum of <code>firstGroup</code> and <code>groupCount</code> <strong class=\"purple\">must</strong> be less than or equal to the number of shader groups in <code>pipeline</code>"
        },
        {
          "vuid": "VUID-vkGetRayTracingShaderGroupHandlesKHR-dataSize-02420",
@@ -7970,9 +7974,13 @@
    },
    "vkGetRayTracingCaptureReplayShaderGroupHandlesKHR": {
      "(VK_NV_ray_tracing,VK_KHR_ray_tracing)+(VK_KHR_ray_tracing)": [
+        {
+          "vuid": "VUID-vkGetRayTracingCaptureReplayShaderGroupHandlesKHR-firstGroup-04051",
+          "text": " <code>firstGroup</code> <strong class=\"purple\">must</strong> be less than the number of shader groups in <code>pipeline</code>"
+        },
        {
          "vuid": "VUID-vkGetRayTracingCaptureReplayShaderGroupHandlesKHR-firstGroup-03483",
-          "text": " The sum of <code>firstGroup</code> and <code>groupCount</code> <strong class=\"purple\">must</strong> be less than the number of shader groups in <code>pipeline</code>"
+          "text": " The sum of <code>firstGroup</code> and <code>groupCount</code> <strong class=\"purple\">must</strong> be less than or equal to the number of shader groups in <code>pipeline</code>"
        },
        {
          "vuid": "VUID-vkGetRayTracingCaptureReplayShaderGroupHandlesKHR-dataSize-03484",
--- a/registry/vk.xml
+++ b/registry/vk.xml
@@ -157,7 +157,7 @@ server.
        <type category="define">// Vulkan 1.2 version number
 #define <name>VK_API_VERSION_1_2</name> <type>VK_MAKE_VERSION</type>(1, 2, 0)// Patch version should always be set to 0</type>
        <type category="define">// Version of this file
-#define <name>VK_HEADER_VERSION</name> 140</type>
+#define <name>VK_HEADER_VERSION</name> 141</type>
        <type category="define" requires="VK_HEADER_VERSION">// Complete version of this file
 #define <name>VK_HEADER_VERSION_COMPLETE</name> <type>VK_MAKE_VERSION</type>(1, 2, VK_HEADER_VERSION)</type>

@@ -5970,7 +5970,8 @@ typedef void <name>CAMetalLayer</name>;
        <enum value="0x10002" name="VK_VENDOR_ID_VSI"   comment="VeriSilicon vendor ID"/>
        <enum value="0x10003" name="VK_VENDOR_ID_KAZAN" comment="Kazan Software Renderer"/>
        <enum value="0x10004" name="VK_VENDOR_ID_CODEPLAY" comment="Codeplay Software Ltd. vendor ID"/>
-            <unused start="0x10005" comment="This is the next unused available Khronos vendor ID"/>
+        <enum value="0x10005" name="VK_VENDOR_ID_MESA"  comment="Mesa vendor ID"/>
+            <unused start="0x10006" comment="This is the next unused available Khronos vendor ID"/>
    </enums>
    <enums name="VkDriverId" type="enum">
        <comment>Driver IDs are now represented as enums instead of the old
@@ -5988,6 +5989,7 @@ typedef void <name>CAMetalLayer</name>;
        <enum value="10"      name="VK_DRIVER_ID_GOOGLE_SWIFTSHADER"            comment="Google LLC"/>
        <enum value="11"      name="VK_DRIVER_ID_GGP_PROPRIETARY"               comment="Google LLC"/>
        <enum value="12"      name="VK_DRIVER_ID_BROADCOM_PROPRIETARY"          comment="Broadcom Inc."/>
+        <enum value="13"      name="VK_DRIVER_ID_MESA_LLVMPIPE"                 comment="Mesa"/>
    </enums>
    <enums name="VkConditionalRenderingFlagBitsEXT" type="bitmask">
        <enum bitpos="0"    name="VK_CONDITIONAL_RENDERING_INVERTED_BIT_EXT"/>
@@ -13391,5 +13393,23 @@ typedef void <name>CAMetalLayer</name>;
                <enum value="&quot;VK_EXT_extension_342&quot;"              name="VK_EXT_EXTENSION_342_EXTENSION_NAME"/>
            </require>
        </extension>
+        <extension name="VK_ARM_extension_343" number="343" author="ARM" contact="Jan-Harald Fredriksen @janharaldfredriksen-arm" supported="disabled">
+            <require>
+                <enum value="0"                                             name="VK_ARM_EXTENSION_343_SPEC_VERSION"/>
+                <enum value="&quot;VK_ARM_extension_343&quot;"              name="VK_ARM_EXTENSION_343_EXTENSION_NAME"/>
+            </require>
+        </extension>
+        <extension name="VK_ARM_extension_344" number="344" author="ARM" contact="Jan-Harald Fredriksen @janharaldfredriksen-arm" supported="disabled">
+            <require>
+                <enum value="0"                                             name="VK_ARM_EXTENSION_344_SPEC_VERSION"/>
+                <enum value="&quot;VK_ARM_extension_344&quot;"              name="VK_ARM_EXTENSION_344_EXTENSION_NAME"/>
+            </require>
+        </extension>
+        <extension name="VK_ARM_extension_345" number="345" author="ARM" contact="Jan-Harald Fredriksen @janharaldfredriksen-arm" supported="disabled">
+            <require>
+                <enum value="0"                                             name="VK_ARM_EXTENSION_345_SPEC_VERSION"/>
+                <enum value="&quot;VK_ARM_extension_345&quot;"              name="VK_ARM_EXTENSION_345_EXTENSION_NAME"/>
+            </require>
+        </extension>
    </extensions>
 </registry>
--- a/registry/vkconventions.py
+++ b/registry/vkconventions.py
@@ -130,11 +130,6 @@ class VulkanConventions(ConventionsBase):
        else:
            return None

-    @property
-    def xml_supported_name_of_api(self):
-        """Return the supported= attribute used in API XML"""
-        return 'vulkan'
-
    @property
    def api_prefix(self):
        """Return API token prefix"""
@@ -195,7 +190,7 @@ class VulkanConventions(ConventionsBase):
    @property
    def extra_refpage_headers(self):
        """Return any extra text to add to refpage headers."""
-        return 'include::../config/attribs.txt[]'
+        return 'include::{config}/attribs.txt[]'

    @property
    def extension_index_prefixes(self):