mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-02-25 12:35:11 +00:00
cebb71d062
* Bump API patch number and header version number to 50 for this update.
Github Issues:
* Fix numerous minor issues with the VK_EXT_debug_report extension (public
issues 478, 483, 486, 489, 490).
Internal Issues:
* Update flink:vkAllocateDescriptorSets to specify conditions under which
to return ename:VK_ERROR_FRAGMENTED_POOL or
ename:VK_ERROR_OUT_OF_POOL_MEMORY instead of
out-of-host/out-of-device-memory, and improve the
<<fundamentals-errorcodes, description of those errors (internal issue
654).
* Add a NOTE documenting that flink:vkAcquireNextImageKHR can only signal
a single semaphore, and how to deal with that when multiple physical
devices in a logical device need to wait on it (internal issue 730).
* Improve description of pname:pNext chains of
slink:VkPhysicalDeviceImageFormatInfo2KHR and
slink:VkImageFormatProperties2KHR (internal issue 814).
* Clean up math markup issues in the <<textures, Image Operations>>
chapter (internal issue 818).
* Update validusage target to use more robust code for preprocessing, by
making direct use of Asciidoctor's preprocessor. Added uniqueItems check
to JSON vu schema and add clean_validusage target (internal issue 826).
* Update style guide to prohibit writing non-self-contained (on a single
bullet point) Valid Usage statements, and modify offending Valid Usage
statements in the Specification to match, to assist with automatic
extraction for the validation layers (internal issue 828).
* Add ename:VK_VALIDATION_CHECK_SHADERS_EXT to elink:VkValidationCheckEXT
of the `VK_EXT_validation_flags` extension, to selectively disable
shader validation.
* Remove duplicate valid usage statement for slink:VkImageMemoryBarrier.
* Modify reflow.py script to place VUID tag anchors standalone on a line
following their corresponding bullet point, and reflow the spec text
accordingly (this had been pending since the initial tag deployment).
New Extensions:
* `VK_AMD_texture_gather_bias_lod`
103 lines
3.5 KiB
Python
Executable File
103 lines
3.5 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
#
|
|
# Copyright (c) 2016-2017 The Khronos Group Inc.
|
|
#
|
|
# 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.
|
|
|
|
# Build Promoter submission package for a specified extension or extensions
|
|
# This consists of one spec with the extension(s) and all dependencies,
|
|
# one with just the dependencies, and an htmldiff of them.
|
|
#
|
|
# This script lives in doc/specs/vulkan/config, but is executed from the
|
|
# parent directory.
|
|
#
|
|
# Usage: makeSubmit extension targets
|
|
|
|
import argparse, copy, io, os, pdb, re, string, sys
|
|
|
|
#newpath = os.path.dirname(__file__) + '/config'
|
|
#sys.path.append(newpath)
|
|
|
|
from extDependency import *
|
|
|
|
# Make a single submission target. Several are needed per document.
|
|
#
|
|
# outDir - where to generate intermediate and final documents
|
|
# extensionList - list of extensions to include
|
|
# submitName - base name of final HTML file
|
|
# title - document title
|
|
# target - default 'html'
|
|
def makeTarget(outDir, extensionList, submitName, title, target):
|
|
print('make clean_generated')
|
|
print('make OUTDIR=' + outDir,
|
|
'EXTENSIONS="' + ' '.join(extensionList) + '"',
|
|
'APITITLE="' + title + '"', target)
|
|
# Rename into submission directory
|
|
outFile = outDir + '/html/' + submitName + '.html'
|
|
print('mv', outDir + '/html/vkspec.html', outFile)
|
|
# No longer needed
|
|
# print('mv -n', outDir + '/katex', 'out/submit/')
|
|
|
|
return outFile
|
|
|
|
# Make submission for a list of required extension names
|
|
def makeSubmit(submitName, required, target='html'):
|
|
global extensions
|
|
|
|
deps = []
|
|
for name in required:
|
|
if name in extensions.keys():
|
|
for depname in extensions[name]:
|
|
if (depname not in required and depname not in deps):
|
|
deps.append(depname)
|
|
|
|
print('echo Required extensions:', ' '.join(required))
|
|
print('echo Dependent extensions:', ' '.join(deps))
|
|
print('')
|
|
|
|
# Generate shell commands to build the specs
|
|
outDir = 'submit'
|
|
print('mkdir -p', outDir)
|
|
|
|
# Generate spec with required extensions + dependencies
|
|
newSpec = makeTarget(outDir, required + deps, submitName,
|
|
submitName, target)
|
|
|
|
# Generate base spec with just dependencies
|
|
baseSpec = makeTarget(outDir, deps, 'deps-' + submitName,
|
|
'(with only dependencies of ' + submitName + ')',
|
|
target)
|
|
|
|
# # Reorganize and rename them, and generate the diff spec
|
|
print('')
|
|
print('cd scripts')
|
|
print('./htmldiff',
|
|
'../' + baseSpec,
|
|
'../' + newSpec,
|
|
'> ../submit/html/diff-' + submitName + '.html')
|
|
print('cd ..')
|
|
|
|
if __name__ == '__main__':
|
|
parser = argparse.ArgumentParser()
|
|
|
|
parser.add_argument('-title', action='store',
|
|
default='vkspec',
|
|
help='Set the document title')
|
|
parser.add_argument('-extension', action='append',
|
|
default=[],
|
|
help='Specify a required extension or extensions to add to targets')
|
|
|
|
results = parser.parse_args()
|
|
|
|
makeSubmit(results.title, results.extension)
|