Vulkan-Docs/scripts/README.md

27 lines
1.2 KiB
Markdown
Raw Normal View History

Change log for November 11, 2016 Vulkan 1.0.33 spec update: * Bump API patch number and header version number to 33 for this update. Github Issues: * Added implicit external synchronization parameters to vkBegin/EndCommandBuffer, and fixed missing command pool host synchronization from per-command lists (public issue 398). * Started using git tags including the spec release number, such as 'v1.0.32-core', instead of tags including the date of release, such as 'v1.0-core-20161025' (public issue 405). Internal Issues: * Add validity constraint for slink:VkImportMemoryWin32HandleInfoNV::pname:handle (internal issue #480). * Add scripts to compare two Vulkan HTML specifications, derived from W3 htmldiff service (internal issue 525). * Relax requirement that memoryTypeBits can't depend on format, to allow it to differ only for depth/stencil formats (internal issue 544). * Add a new generator script to create a simple extension loader for Vulkan based on +vk.xml+ (internal issue 558). * Add the overlooked requirement that buffer and image memory alignment requirements must be a power of two in the <<resources-association,Resource Memory Association>> section (internal issue 569). Other Issues: * Add a naming rule to the style guide for members of extension structures defining array lengths which are the same as array lengths of the core structure they are chained from. * Add a new generator to create a simple extension loader in +src/ext_loader/vulkan_ext.[ch]+ from +vk.xml+. This code can be included in your project, and is expected to be packaged in the Vulkan SDK provided by LunarG in the future.
2016-11-12 11:23:34 +00:00
HTML Diff Script for Vulkan
===========================
This is a first cut at a script to compare Vulkan HTML specifications. Usage
is simply 'htmldiff file1.html file2.html > diff.html'. The script does not
copy CSS and images requires by the input specs, so it's best to generate
the output in the same directory as one of the inputs.
The scripts used require Python and Perl. Additionally, the python
'utidylib' module and the underlying libtidy C library are required,
which may make it challenging to run the scripts on non-Linux platforms
- I haven't checked and those requirements cannot be easily removed. On
Debian Linux, it may be necessary to install the 'python-utidylib' and
'libtidy' packages if they are not already present. I haven't checked
dependencies for other Linux distributions but they are probably
similar.
The scripts are taken from the code backing the
http://services.w3.org/htmldiff
website. 'htmldiff' is the Python driver script. 'htmldiff.pl' is the
Perl script which generates the diff after preprocessing of the input
HTML by 'htmldiff'. 'htmldiff.orig' is the original Python script from
the website, modified to run at the command line instead of as a CGI
script.