mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-02-01 00:55:16 +00:00
2656f45933
* Bump API patch number and header version number to 13 for this
update.
Github Issues:
* Improve the description of ename:VK_PRESENT_MODE_FIFO_RELAXED_KHR in the
VK_KHR_surface extension (public issue 174).
* Clarify use of etext:*_SIMULTANEOUS_USE_BIT for secondary command
buffers (public issue 182).
* Fix typos in VK_KHR_wayland_surface extension where code:wl_device was
used instead of code:wl_display (public issue 193).
* Replaced {apiname} with ``Vulkan'' in XML validity statements (public
issue 199).
* Fix dead links for WSI handle types (public issue 200).
*** N.b. this needs to be done in WSI branches as well ***
* Use "signaled" instead of "signalled" spelling everywhere (public issue
201).
*** N.b. this needs to be done in WSI branches as well ***
* Move readme.pdf target directory for XML schema documentation into the
target generation directory, instead of leaving it checked into the spec
source tree (public issue 203).
*** N.b. need to add generated PDF to registry index/1.0 page
* Fix duplicate 'which which' typo in description of
elink:VkCommandPoolResetFlagBits (public issue 204).
* Move the <<Programmable Primitive Shading>> section up one level, out of
the <<drawing-primitive-topologies,Primitive Topologies>> section
(public issue 209).
Internal Issues:
* Clarify in the <<pipelines-cache,Pipeline Cache>> section that
implementations should not manage the size of pipeline cache (internal
issue 192).
* Deprecate the concept of device layers and associated commands (internal
issue 255).
* Remove ename:VK_INCOMPLETE from the list of possible result codes of
flink:vkGetPhysicalDeviceSurfaceCapabilitiesKHR (internal issue 314).
* Add missing std140/std430 rule: the base alignment of a member following
a structure is a multiple of the structure's base alignment (internal
issue 321).
* Fixes naming of the single elink:VkColorSpaceKHR enum from
ename:VK_COLORSPACE_SRGB_NONLINEAR_KHR to
ename:VK_COLOR_SPACE_SRGB_NONLINEAR_KHR in XML/header and the
VK_KHR_swapchain and VK_KHR_surface extensions to match the style of the
typename (space and color are two words, not one) (internal issue 322).
* Make it clear that code:LocalInvocationID should only be applied to an
input variable and normalize the language describing
code:LocalInvocationID to the language for other compute shader
variables in the <<interfaces-builtin-variables,Built-in Variables>>
section, and add normative language (internal issue 323).
* Clarify in the <<fundamentals-returncodes,Return Codes>> section that
the result pointer may be modified for specific commands, even if a
runtime error is returned (internal issue 324).
97 lines
3.1 KiB
Python
Executable File
97 lines
3.1 KiB
Python
Executable File
#!/usr/bin/python3
|
|
|
|
import time
|
|
from datetime import *
|
|
|
|
# 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 regnerated all automatically-regeneratable
|
|
# files. After completing the build, the current branch is set to
|
|
# the first (core) branch and suggestions for creating tags are printed out.
|
|
|
|
# branch = branch or commit or tag name
|
|
# label = textual label to apply
|
|
# outdir = directory to generate specs in
|
|
# xmlTargets = targets to build in src/spec/
|
|
# specTargets = targets to build in doc/specs/vulkan/
|
|
def buildRelease(branch,label,outdir,xmlTargets,specTargets):
|
|
global root, xml, spec
|
|
|
|
print('echo Info: Generating branch=' + branch,
|
|
'label=' + label,
|
|
'outdir=' + outdir)
|
|
print('git checkout', branch)
|
|
|
|
print('echo Info: Cleaning spec in', outdir)
|
|
print('cd', spec)
|
|
print('rm -rf',
|
|
outdir + '/man',
|
|
outdir + '/xhtml',
|
|
outdir + '/pdf',
|
|
outdir + '/chunked',
|
|
outdir + '/vkspec.html',
|
|
'specversion.txt')
|
|
|
|
print('echo Info: Generating headers and spec include files')
|
|
print('cd', xml)
|
|
print('make OUTDIR=' + outdir, xmlTargets)
|
|
|
|
print('echo Info: Generating spec')
|
|
print('cd', spec)
|
|
print('make specversion.txt')
|
|
print('make -j 4 OUTDIR=' + outdir, ' NOTEOPTS="-a implementation-guide"',
|
|
specTargets)
|
|
print('rm', outdir + '/pdf/vkspec.xml')
|
|
|
|
# Main
|
|
|
|
global root, xml, spec
|
|
|
|
# Root of the Vulkan git repo containing the specs
|
|
root = '/home/tree/git/Vulkan-Docs'
|
|
# Directory with vk.xml and generation tools
|
|
xml = root + '/src/spec'
|
|
# Directory with spec sources
|
|
spec = root + '/doc/specs/vulkan'
|
|
|
|
# Output directory, which does not have to be (and probably
|
|
# should not be) in the spec repo
|
|
outdir = '/home/tree/git/Vulkan-Web-Registry/specs/'
|
|
|
|
# These can be changed to tags, etc.
|
|
corebranch = '1.0'
|
|
wsibranch = '1.0-wsi_extensions'
|
|
|
|
# date in YYYYMMDD format
|
|
now = datetime.today().strftime('%Y%m%d')
|
|
|
|
# Generate specs
|
|
coreXmlTargets='clobber full_install pdf_install'
|
|
coreSpecTargets='xhtml pdf styleguide manhtml manpdf manhtmlpages'
|
|
buildRelease(corebranch, corebranch, outdir + corebranch,
|
|
coreXmlTargets, coreSpecTargets)
|
|
|
|
wsiXmlTargets='clobber full_install'
|
|
wsiSpecTargets='xhtml pdf'
|
|
buildRelease(wsibranch, wsibranch, outdir + wsibranch,
|
|
wsiXmlTargets, wsiSpecTargets)
|
|
|
|
print('echo Info: post-generation cleanup')
|
|
|
|
print('git checkout ' + corebranch)
|
|
|
|
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)
|