mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-02-26 04:55:12 +00:00
5abf83f95d
* Update release number to 107.
Public Issues:
* Fix revision date for the `<<VK_AMD_gpu_shader_half_float>>` appendix
(public issue 617).
* Make <<synchronization-pipeline-barriers-subpass-self-dependencies,
subpass self-dependencies>> less restrictive (public issue 777).
* Fix the `<<VK_EXT_full_screen_exclusive>>` dependency on
`<<VK_KHR_win32_surface>>` in `vk.xml` (public pull request 849).
* Remove single-page (`apispec.html`) refpage sub-targets from the
Makefile `allman` target and the build instructions. The target is still
present in the Makefile, but we have not been actively maintaining the
single-page document and do not promise it will work. The full
Specification and the individual API reference pages are what we support
and publish at present (public issue 949).
Internal Issues:
* De-duplicate common valid usage statements shared by multiple commands
or structures by using asciidoctor includes and dynamically assigning
part of the valid usage ID based on which command or structure they're
being applied to (internal issue 779).
* Add reference pages for constructs not part of the formal API, such as
platform calling convention macros, and script changes supporting them
This required suppressing some check_spec_links warning classes in order
to pass CI, until a more sophisticated fix can be done (internal issue
888).
* Change math notation for the elink:VkPrimitiveTopology descriptions to
use short forms `v` and `p` instead of `vertex` and `primitive`,
increasing legibility (internal issue 1611).
* Rewrite generated file includes relative to a globally specified path,
fixing some issues with refpage generation (internal issue 1630).
* Update contributor list for `<<VK_EXT_calibrated_timestamps>>`.
* Fix use of pathlin in `scripts/generator.py` so the script will work on
Windows under Python 3.5 (internal merge request 3107).
* Add missing conditionals around the
<<descriptorsets-accelerationstructure, Acceleration Structure>>
section (internal merge request 3108).
* More script synchronization with OpenXR spec repository (internal merge
request 3109).
* Mark the `<<VK_AMD_gpu_shader_half_float>>` and
`<<VK_AMD_gpu_shader_int16>>` extensions as deprecated in `vk.xml` and
the corresponding extension appendices (internal merge request 3112).
New Extensions:
* `<<VK_EXT_headless_surface>>`
139 lines
4.8 KiB
Python
Executable File
139 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 = tuple() # TODO - defines mentioned in spec but not needed in registry
|
|
|
|
# These are marked with the code: macro
|
|
SYSTEM_TYPES = set(('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):
|
|
"""Create a correctly-configured MacroChecker instance."""
|
|
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)
|