mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-01-12 15:04:10 +00:00
df88ded281
* Bump API patch number and header version number to 60 for this update.
Github Issues:
* Document that <<queries-timestamps, Timestamp Queries>> can only be
meaningfully compared when they are written from the same queue (public
issue 216).
* Document that the `<extension>` tag `type` attribute is required for
non-disabled extensions (derived from, but does not close public issue
354).
* Clean up registry schema length attribute descriptions to be consistent
and correct (public issue 555).
Internal Issues:
* Replace as much of the hand-written extension appendix metadata as
possible with asciidoc includes generated from corresponding attributes
of +vk.xml+, and enhance the style guide to match. This avoids
inconsistencies between +vk.xml+ and the appendices, and produces a more
uniform style (internal issue 137).
* Remove the generated extDependency.{py,sh} files from the tree and
create them dynamically on demand instead, reducing merge conflicts
(internal issue 713).
* Add a prototype tool for generating in-place difference markup for
sections guarded by asciidoc conditionals, and new syntax for open
blocks to support it (internal issue 833).
* Remove unnecessary restriction of etext:*SYNC_FD_BIT_KHR external handle
types to the same physical device in the
slink:VkPhysicalDeviceIDPropertiesKHR,
flink:VkImportMemoryWin32HandleInfoKHR,
slink:VkImportFenceWin32HandleInfoKHR, slink:VkImportFenceFdInfoKHR,
slink:VkImportSemaphoreWin32HandleInfoKHR,
slink:VkImportSemaphoreFdInfoKHR
<<external-memory-handle-types-compatibility, External memory handle
types compatibility>>, <<external-semaphore-handle-types-compatibility,
External semaphore handle types compatibility>>, and
<<external-fence-handle-types-compatibility, External fence handle types
compatibility>> sections (internal issue 956).
Other Issues:
* Remove dependency of +VK_KHX_device_group+ on +VK_KHR_swapchain+ (there
is an interaction, but not a strict dependency), and add a new
`extension` attribute to the `<require` XML tag to allow classifying a
subset of interfaces of an extension as requiring another extension.
Update the registry schema and documentation accordingly.
New Extensions:
* `VK_AMD_shader_fragment_mask` (and related `GL_AMD_shader_fragment_mask`
GLSL extension)
* `VK_EXT_sample_locations`
* `VK_EXT_validation_cache`
103 lines
3.6 KiB
Python
Executable File
103 lines
3.6 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, subprocess, sys
|
|
|
|
# Ensure config/extDependency.py is up-to-date before we import it.
|
|
subprocess.check_call(['make', 'config/extDependency.py'])
|
|
|
|
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)
|