mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-01-12 15:04:10 +00:00
1ca0ea1ef0
* Bump API patch number and header version number to 22 for this update.
Github Issues:
* Translate the subpass self-dependency language into concrete
validity statements, and added a validity statement about the
restrictions on layout parameters (public issue 267).
* Add validity requirement that
slink:VkAttachmentDescription::pname:finalLayout and
slink:VkAttachmentReference::pname:layout must not be
ename:VK_IMAGE_LAYOUT_UNDEFINED or
ename:VK_IMAGE_LAYOUT_PREINITIALIZED (public issue 268).
* Clarify that slink:VkSubpassDescription::pname:pResolveAttachments
layouts are used. Make language consistent with other attachment
arrays (public issue 270).
* Changed 64-bit definition for
dname:VK_DEFINE_NON_DISPATCHABLE_HANDLE to work for x32 platform in
+vk.xml+ and the resulting +vulkan.h+ (public issue 282).
* Add missing error return code for
flink:vkEnumerateInstanceExtensionProperties and
flink:vkEnumerateDeviceExtensionProperties (public issue 285)
* Fix several cases of stext::VkStructName.memberName markup to
stext::VkStructName::pname:memberName, to match other usage in the
spec, and describe this markup in the style guide (public issue
286).
* Modified validity language generation script to avoid redundant
common ancestor language if covered by generic parent language, and
used `Both' instead of `Each' when appropriate (public issue 288).
Internal Issues:
* Add language about behavior of flink:vkAllocateDescriptorSets when
allocation fails due to fragmentation, a new error
ename:VK_ERROR_FRAGMENTED_POOL, and a Note explaining the situation
(internal issue 309).
* For the features of code:PointSize, code:ClipDistance, and
code:CullDistance, the SPIR-V capability is required to be declared
on use (read or write) rather than on decoration (internal issue
359).
* Have desktop versions of GLSL respect precision qualification
(code:mediump and code:lowp) when compiling for Vulkan. These will
get translated to SPIR-V's code:RelaxedPrecision decoration as they
do with OpenGL ES versions of GLSL (ESSL). The default precision of
all types is code:highp when using a desktop version (internal issue
360).
* Add validity statement for slink:VkImageCreateInfo specifying that
multisampled images must be two-dimensional, optimally tiled, and
with a single mipmap level (internal issue 369).
* Add validity statements to slink:VkImageViewCreateInfo disallowing
creation of images or image views with no supported features. Made
some slink:VkImageViewCreateInfo validity statements more precise
and consistent. Added a Note to the <<features,features>> chapter
about formats with no features (internal issue 371).
* Remove +manpages+ from default build targets. Nroff outputs
containing imbedded latexmath will not render properly. Fixing this
is a lot of work for limited use cases (internal issue 401).
Other Commits:
* Fix flink:vkRenderPassBeginInfo::pname:clearValueCount validity
statement to be based on attachment indices rather than the number
of cleared attachments
(Vulkan-LoaderAndValidationLayers/issues/601).
* Convert registry documentation from LaTeX to asciidoc source and
rename from +src/spec/readme.tex+ to +src/spec/registry.txt+.
* Fix lack of Oxford commas in validity language.
* Lots of cleanup of generator scripts and Makefiles to move extension
list for generator into the script arguments instead of the body of
genvk.py, and express better dependencies between XML, scripts, and
generated files.
105 lines
3.8 KiB
Python
Executable File
105 lines
3.8 KiB
Python
Executable File
#!/usr/bin/python3
|
|
|
|
import time
|
|
from datetime import timedelta, date
|
|
|
|
# These can be changed to tags, etc.
|
|
coreBranch = '1.0'
|
|
wsiBranch = '1.0-wsi_extensions'
|
|
|
|
# This script builds a full release package including XHTML and PDF
|
|
# versions of the specified branches (usually 1.0 and 1.0-wsi_extensions,
|
|
# but tags or commits can be used as well). Other files in the release
|
|
# directory are removed, including man pages, XHTML chunked, HTML,
|
|
# validity output, etc.
|
|
#
|
|
# Both branches must be fully committed and up to date when the script
|
|
# is run, with no outstanding un-added / un-committed files. Both
|
|
# branches must have fully regenerated all automatically generated
|
|
# files. After completing the build, the current branch is set to
|
|
# the first (core) branch and suggestions for creating tags are printed out.
|
|
|
|
# Return a date for the current, or upcoming if not already, Friday,
|
|
# which is when releases happen
|
|
def buildOnFriday():
|
|
today = date.today()
|
|
friday = today + timedelta((4 - today.weekday()) % 7)
|
|
return friday
|
|
|
|
# branch = branch or commit or tag name
|
|
# label = textual label to apply
|
|
# outdir = directory to generate specs in
|
|
# xmlDir = directory containing registry XML
|
|
# xmlTargets = targets to build in src/spec/
|
|
# specDir = directory containing spec source & Makefile
|
|
# specTargets = targets to build in doc/specs/vulkan/
|
|
# miscSrc = path to copy misc files from, if non-None
|
|
# miscDst = path to copy misc files to, if non-None
|
|
def buildRelease(branch, label, outdir,
|
|
xmlDir, xmlTargets,
|
|
specDir, specTargets,
|
|
miscSrc = None, miscDst = None):
|
|
print('echo Info: Generating branch=' + branch,
|
|
'label=' + label,
|
|
'outdir=' + outdir)
|
|
print('git checkout', branch)
|
|
|
|
# print('echo Info: Cleaning spec in', outdir)
|
|
print('(cd ', outdir, '&& rm -rf',
|
|
'xhtml chunked pdf',
|
|
'man config checks',
|
|
'vkspec.html styleguide.html apispec.html apispec.pdf registry.html',
|
|
')')
|
|
|
|
# print('echo Info: Generating specversion.txt')
|
|
print('cd', specDir)
|
|
print('rm specversion.txt ; make specversion.txt')
|
|
|
|
# print('echo Info: Generating headers and spec include files')
|
|
print('cd', xmlDir)
|
|
print('make OUTDIR=' + outdir, xmlTargets)
|
|
|
|
# print('echo Info: Generating spec')
|
|
print('cd', specDir)
|
|
print('make -j 8 OUTDIR=' + outdir, ' NOTEOPTS="-a implementation-guide"',
|
|
specTargets)
|
|
|
|
if (miscSrc != None and miscDst != None):
|
|
print('cp', miscSrc + '/*.txt', miscDst + '/')
|
|
|
|
|
|
# Build all target branches
|
|
# repoDir = path to the Vulkan git repo containing the specs
|
|
# outDir = path to the output base directory in which each branch is generated
|
|
def buildBranch(branch, xmlTargets, specTargets, repoDir, outDir):
|
|
# Directory with vk.xml and generation tools
|
|
xmlDir = repoDir + '/src/spec'
|
|
# Directory with spec sources
|
|
specDir = repoDir + '/doc/specs/vulkan'
|
|
# Src/dst directories with misc. GLSL extension specs
|
|
miscSrc = repoDir + '/doc/specs/misc'
|
|
miscDst = outDir + '/misc'
|
|
|
|
buildRelease(branch, branch, outDir + '/' + branch,
|
|
xmlDir, xmlTargets, specDir, specTargets,
|
|
miscSrc, miscDst)
|
|
|
|
# Commands to tag the git branches
|
|
# tagdate = date to tag the tree with when done
|
|
def createTags(tagdate):
|
|
global coreBranch, wsiBranch
|
|
|
|
# Tag date in YYYYMMDD format
|
|
now = tagdate.strftime('%Y%m%d')
|
|
|
|
print('echo To tag the spec branches, execute these commands:')
|
|
print('echo git checkout', coreBranch)
|
|
print('echo git tag -a -m \\"Tag core API specification for', now,
|
|
'release\\"', 'v1.0-core-' + now)
|
|
|
|
print('echo git checkout', wsiBranch)
|
|
print('echo git tag -a -m \\"Tag core+WSI API specification for', now,
|
|
'release\\"', 'v1.0-core+wsi-' + now)
|
|
|
|
|