From 3e2df678743c4dcfc35c29c84894842e81538eea Mon Sep 17 00:00:00 2001
From: Oskar Viljasaar <oskar.viljasaar@gmail.com>
Date: Wed, 29 Nov 2023 17:03:05 +0200
Subject: [PATCH] vulkan/properties: Document RENAMED_PROPERTIES in the
 property generator

Reviewed-by: Konstantin Seurer <konstantin.seurer@gmail.com>
Reviewed-by: Faith Ekstrand <faith.ekstrand@collabora.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/26386>
---
 src/vulkan/util/vk_physical_device_properties_gen.py | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/vulkan/util/vk_physical_device_properties_gen.py b/src/vulkan/util/vk_physical_device_properties_gen.py
index 9847c10cf6f..2f5b7fd1213 100644
--- a/src/vulkan/util/vk_physical_device_properties_gen.py
+++ b/src/vulkan/util/vk_physical_device_properties_gen.py
@@ -41,6 +41,13 @@ def str_removeprefix(s, prefix):
         return s[len(prefix):]
     return s
 
+# Some extensions have been promoted to core, their properties are renamed
+# in the following hashtable.
+# The hashtable takes the form:
+# (VkPhysicalDevice{PropertyStruct}, PropertyName): RenamedPropertyName
+# Drivers just have to fill the RenamedPropertyName field in their struct
+# vk_properties, the runtime will expose the data with the original/right
+# name to consumers.
 RENAMED_PROPERTIES = {
     ("DrmPropertiesEXT", "hasPrimary"): "drmHasPrimary",
     ("DrmPropertiesEXT", "primaryMajor"): "drmPrimaryMajor",