Vulkan-Docs/doc/specs/vulkan/scripts
Jon Leech 1d67e47f14 Change log for June 4, 2017 Vulkan 1.0.51 spec update:
* Bump API patch number and header version number to 51 for this update.

Github Issues:

  * Add Valid Usage statement to flink:vkCmdResolveImage to require that
    source and destination image formats match (public issue 492).
  * Specify that a code:char* parameter must: be a valid null-terminated
    string in the <<fundamentals-implicit-validity, implicit valid usage>>
    section (public issue 494).
  * Removed unnecessary VU for slink:VkPhysicalDeviceFeatures which is
    covered by ename:VK_ERROR_FEATURE_NOT_PRESENT already (public issue
    496).
  * Clarify valid usage of pname:pQueueFamilyIndices in
    slink:VkBufferCreateInfo, slink:VkImageCreateInfo, and
    slink:VkSwapchainCreateInfoKHR (public issue 501).
  * Document that dependencies of enabled extensions must also be enabled in
    the <<extended-functionality-extensions-dependencies, Extension
    Dependencies>> section (public issue 507).

Internal Issues:

  * Change slink:VkMappedMemoryRange valid usage to allow pname:offset +
    pname:size == size of the allocation. Also, if ename:VK_WHOLE_SIZE is
    used, require the end of the mapping to be aligned to a multiple of
    pname:nonCoherentAtomSize (internal issue 611).
  * Add issue to `VK_KHR_win32_surface` about reusing window objects from a
    different graphics API or Vulkan ICD (internal issue 639).
  * Require locations on user in/out in `GL_KHR_vulkan_glsl` (internal issue
    783).
  * Added version info to the json validation output, and updated the schema
    to match (internal issue 838).
  * Restructure enumerated type descriptions separately from the command or
    structure they are used in, allowing better reference page generation
    (internal issue 841).
  * Re-sort extension appendices to be in alphabetical order within each
    author ID section.
  * Fix enum naming and clarify behavior for
    `VK_NVX_device_generated_commands` extension.

New Extensions:
2017-06-04 20:48:43 -07:00
..
README.md Change log for November 11, 2016 Vulkan 1.0.33 spec update: 2016-11-12 03:23:34 -08:00
checkXrefs Change log for March 17, 2017 Vulkan 1.0.44 spec update: 2017-03-17 22:53:58 -07:00
htmldiff Change log for June 4, 2017 Vulkan 1.0.51 spec update: 2017-06-04 20:48:43 -07:00
htmldiff.orig Change log for November 11, 2016 Vulkan 1.0.33 spec update: 2016-11-12 03:23:34 -08:00
htmldiff.pl Change log for November 11, 2016 Vulkan 1.0.33 spec update: 2016-11-12 03:23:34 -08:00
insertTags.py Change log for February 27, 2017 Vulkan 1.0.42 spec update: 2017-02-26 22:54:26 -08:00

README.md

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.