5abf83f95d
* Update release number to 107.
Public Issues:
* Fix revision date for the `<<VK_AMD_gpu_shader_half_float>>` appendix
(public issue 617).
* Make <<synchronization-pipeline-barriers-subpass-self-dependencies,
subpass self-dependencies>> less restrictive (public issue 777).
* Fix the `<<VK_EXT_full_screen_exclusive>>` dependency on
`<<VK_KHR_win32_surface>>` in `vk.xml` (public pull request 849).
* Remove single-page (`apispec.html`) refpage sub-targets from the
Makefile `allman` target and the build instructions. The target is still
present in the Makefile, but we have not been actively maintaining the
single-page document and do not promise it will work. The full
Specification and the individual API reference pages are what we support
and publish at present (public issue 949).
Internal Issues:
* De-duplicate common valid usage statements shared by multiple commands
or structures by using asciidoctor includes and dynamically assigning
part of the valid usage ID based on which command or structure they're
being applied to (internal issue 779).
* Add reference pages for constructs not part of the formal API, such as
platform calling convention macros, and script changes supporting them
This required suppressing some check_spec_links warning classes in order
to pass CI, until a more sophisticated fix can be done (internal issue
888).
* Change math notation for the elink:VkPrimitiveTopology descriptions to
use short forms `v` and `p` instead of `vertex` and `primitive`,
increasing legibility (internal issue 1611).
* Rewrite generated file includes relative to a globally specified path,
fixing some issues with refpage generation (internal issue 1630).
* Update contributor list for `<<VK_EXT_calibrated_timestamps>>`.
* Fix use of pathlin in `scripts/generator.py` so the script will work on
Windows under Python 3.5 (internal merge request 3107).
* Add missing conditionals around the
<<descriptorsets-accelerationstructure, Acceleration Structure>>
section (internal merge request 3108).
* More script synchronization with OpenXR spec repository (internal merge
request 3109).
* Mark the `<<VK_AMD_gpu_shader_half_float>>` and
`<<VK_AMD_gpu_shader_int16>>` extensions as deprecated in `vk.xml` and
the corresponding extension appendices (internal merge request 3112).
New Extensions:
* `<<VK_EXT_headless_surface>>`
|
||
|---|---|---|
| .. | ||
| README.adoc | ||
| build-index.js | ||
| chunked.css | ||
| chunked.js | ||
| custom.patch | ||
| generate-index.rb | ||
| lunr.js | ||
README.adoc
ifdef::env-github[]
:note-caption: :information_source:
endif::[]
= Index Building For Vulkan Chunked HTML Output
This directory contains scripts which help a search index, and add a
searchbox using this index into each page of the Vulkan chunked HTML
specification output. These files include:
[options="compact"]
* README.adoc - this file
* build-index.js - build a JSON search index from generate-index.rb output
* chunked.css - CSS for the searchbox
* chunked.js - Script to load and execute the searchbox
* custom.patch - Patch to generated HTML to include chunked.js / chunked.css
* generate-index.rb - generate an index of the HTML documents
* lunr.js - utility functions taken from the lunr package
= Credits and Licenses
The indexing tools and toolchain was created by Baldur Karlsson in
https://github.com/baldurk/vkdocs-chunked-builder
Files created in that project are under the Apache 2.0 license.
Portions of the chunked.js script are taken from
https://github.com/filamentgroup/loadJS/blob/master/loadJS.js
These portions are copyright Scott Jehl, Filament Group, Inc., under an MIT
license.
The lunr.js script is taken from the 'lunr' npm package, version 2.3.6. It
is copyright Oliver Nightingale, under an MIT license.