mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-02-13 14:56:26 +00:00
476e3f422d
* Update release number to 104.
Public Issues:
* Remove the incorrect line from "`Initial`" to "`Invalid`" state in the
<<commandbuffer-lifecycle-diagram, Lifecycle of a command buffer>>
diagram (public issue 881).
* Add Fuchsia platform to <<boilerplate-wsi-header-table, Window System
Extensions and Headers>> table (public pull request 933).
* Change the type of
slink:VkBufferDeviceAddressCreateInfoEXT::pname:deviceAddress from
basetype:VkDeviceSize to basetype:VkDeviceAddress. These are both
typedefs of code:uint64_t, so it is an ABI-compatible change (public
issue 934).
Internal Issues:
* Remove generated header files and update the CI tests to build a copy of
the headers for use by the hpp-generate / hpp-compile CI stages. Targets
to generate the headers will not be removed, but keeping these generated
files in the repository increased the frequency of conflicts between
branches when merging to master (internal issue 745).
* Reword "`undefined: behavior if *action*" to "`must: not do *action*`"
in the places the old terminology was used, and add a new
<<writing-undefined, Describing Undefined Behavior>> section of the
style guide to explain how to write such language in the future
(internal issue 1579).
* Move almost all Python scripts into the toplevel `scripts/` directory.
Apply extensive internal edits to clean up and simplify the scripts, and
try to follow PEP8 guidelines. Generalize the scripts with the use of a
Conventions object controlling many aspects of output generation, to
enable their use in other Khronos projects with similar requirements.
Autogenerate extension interface refpages (these are experimental and
may be retired going forward).
New Extensions:
* `VK_AMD_display_native_hdr`
* `VK_EXT_full_screen_exclusive` (internal issue 1439)
* `VK_EXT_host_query_reset`
* `VK_EXT_pipeline_creation_feedback` (internal issue 1560)
* `VK_KHR_surface_protected_capabilities` (internal issue 1520)
138 lines
4.8 KiB
Python
Executable File
138 lines
4.8 KiB
Python
Executable File
#!/usr/bin/python3
|
|
#
|
|
# Copyright (c) 2018-2019 Collabora, Ltd.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
#
|
|
# Author(s): Ryan Pavlik <ryan.pavlik@collabora.com>
|
|
#
|
|
# Purpose: This file performs some basic checks of the custom macros
|
|
# used in the AsciiDoctor source for the spec, especially
|
|
# related to the validity of the entities linked-to.
|
|
|
|
from pathlib import Path
|
|
|
|
from reg import Registry
|
|
from spec_tools.entity_db import EntityDatabase
|
|
from spec_tools.macro_checker import MacroChecker
|
|
from spec_tools.macro_checker_file import MacroCheckerFile
|
|
from spec_tools.main import checkerMain
|
|
from spec_tools.shared import (AUTO_FIX_STRING, EXTENSION_CATEGORY, MessageId,
|
|
MessageType)
|
|
|
|
###
|
|
# "Configuration" constants
|
|
|
|
EXTRA_DEFINES = [] # TODO - defines mentioned in spec but not needed in registry
|
|
|
|
# These are marked with the code: macro
|
|
SYSTEM_TYPES = ['void', 'char', 'float', 'size_t', 'uintptr_t',
|
|
'int8_t', 'uint8_t',
|
|
'int32_t', 'uint32_t',
|
|
'int64_t', 'uint64_t']
|
|
|
|
ROOT = Path(__file__).resolve().parent.parent
|
|
DEFAULT_DISABLED_MESSAGES = set([
|
|
MessageId.LEGACY,
|
|
MessageId.REFPAGE_MISSING,
|
|
MessageId.MISSING_MACRO,
|
|
MessageId.EXTENSION,
|
|
# TODO *text macro checking actually needs fixing for Vulkan
|
|
MessageId.MISUSED_TEXT,
|
|
MessageId.MISSING_TEXT
|
|
])
|
|
|
|
CWD = Path('.').resolve()
|
|
|
|
|
|
class VulkanEntityDatabase(EntityDatabase):
|
|
"""Vulkan-specific subclass of EntityDatabase."""
|
|
|
|
def makeRegistry(self):
|
|
registryFile = str(ROOT / 'xml/vk.xml')
|
|
registry = Registry()
|
|
registry.loadFile(registryFile)
|
|
return registry
|
|
|
|
def getNamePrefix(self):
|
|
return "vk"
|
|
|
|
def getPlatformRequires(self):
|
|
return 'vk_platform'
|
|
|
|
def getSystemTypes(self):
|
|
return SYSTEM_TYPES
|
|
|
|
def populateMacros(self):
|
|
self.addMacros('t', ['link', 'name'], ['funcpointers', 'flags'])
|
|
|
|
def populateEntities(self):
|
|
# These are not mentioned in the XML
|
|
for name in EXTRA_DEFINES:
|
|
self.addEntity(name, 'dlink', category='configdefines')
|
|
|
|
|
|
class VulkanMacroCheckerFile(MacroCheckerFile):
|
|
"""Vulkan-specific subclass of MacroCheckerFile."""
|
|
|
|
def handleWrongMacro(self, msg, data):
|
|
"""Report an appropriate message when we found that the macro used is incorrect.
|
|
|
|
May be overridden depending on each API's behavior regarding macro misuse:
|
|
e.g. in some cases, it may be considered a MessageId.LEGACY warning rather than
|
|
a MessageId.WRONG_MACRO or MessageId.EXTENSION.
|
|
"""
|
|
message_type = MessageType.WARNING
|
|
message_id = MessageId.WRONG_MACRO
|
|
group = 'macro'
|
|
|
|
if data.category == EXTENSION_CATEGORY:
|
|
# Ah, this is an extension
|
|
msg.append(
|
|
'This is apparently an extension name, which should be marked up as a link.')
|
|
message_id = MessageId.EXTENSION
|
|
group = None # replace the whole thing
|
|
else:
|
|
# Non-extension, we found the macro though.
|
|
if data.macro[0] == self.macro[0] and data.macro[1:] == 'link' and self.macro[1:] == 'name':
|
|
# First letter matches, old is 'name', new is 'link':
|
|
# This is legacy markup
|
|
msg.append(
|
|
'This is legacy markup that has not been updated yet.')
|
|
message_id = MessageId.LEGACY
|
|
else:
|
|
# Not legacy, just wrong.
|
|
message_type = MessageType.ERROR
|
|
|
|
msg.append(AUTO_FIX_STRING)
|
|
self.diag(message_type, message_id, msg,
|
|
group=group, replacement=self.makeMacroMarkup(data=data), fix=self.makeFix(data=data))
|
|
|
|
|
|
def makeMacroChecker(enabled_messages):
|
|
entity_db = VulkanEntityDatabase()
|
|
return MacroChecker(enabled_messages, entity_db, VulkanMacroCheckerFile, ROOT)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
default_enabled_messages = set(MessageId).difference(
|
|
DEFAULT_DISABLED_MESSAGES)
|
|
|
|
all_docs = [str(fn)
|
|
for fn in sorted((ROOT / 'chapters/').glob('**/*.txt'))]
|
|
all_docs.extend([str(fn)
|
|
for fn in sorted((ROOT / 'appendices/').glob('**/*.txt'))])
|
|
|
|
checkerMain(default_enabled_messages, makeMacroChecker,
|
|
all_docs)
|