Vulkan-Docs/scripts/__init__.py.docs

34 lines
784 B
Plaintext
Raw Normal View History

Change log for September 8, 2019 Vulkan 1.1.122 spec update: * Update release number to 122. Internal Issues: * Add style guide language on not using standalone `+` signs (internal issue 736); not using leading whitespace for markup (internal issue 747); and on keeping descriptions of a single API in a contiguous block of markup (internal issue 949), and apply them to the specification. * Add a glossary definition of "`constant integral expression`", pointing to the SPIR-V "`constant instruction`" definition (internal issue 1225). * Many minor edits to improve writing style consistency and capture additional style guidelines (internal issue 1553). * Clarify that <<fragops-depth-write, depth writes are not performed>> if there is no depth framebuffer attachment (internal issue 1771). * Allow implementations to use rectangular line style of interpolation for <<primsrast-lines-bresenham, wide Bresenham lines>>, though replicating attributes is still preferred. Clarify that code:FragCoord is not replicated (internal issue 1772). * Resolve a contradiction in valid usage statements for slink:VkImageCreateInfo and slink:VkImageStencilUsageCreateInfoEXT (internal issue 1773). * Add style guide discussion of markup for indented equations, and use markup workaround for asciidoctor 2 compatibility (internal issue 1793). * Deprecate the `<<VK_EXT_validation_flags>>` extension in `vk.xml` and the extension appendix (internal issue 1801). * Add a new checker script `scripts/xml_consistency.py`. This is not currently run as part of internal CI (internal merge request 3285). * Correct "`an`" -> "`a`" prepositions where needed (internal merge request 3334). * Clarify that the <<features-uniformBufferStandardLayout, pname:uniformBufferStandardLayout>> feature is only required when the extension defining it is supported (internal merge request 3341). * Bring scripts into closer sync with OpenXR, mainly through conversion of comments to docstrings where appropriate, and add gen-scripts-docs.sh (internal merge request 3324). * Correct pname:maxDrawMeshTasksCount to 2^16^-1 in the <<limits-required, Required Limits>> table (internal merge requests 3361). New Extensions * `<<VK_IMG_format_pvrtc>>` (public issue 512).
2019-09-08 20:41:02 -07:00
"""Scripts for building the Vulkan specification and artifacts."""
# This is only used during doc builds, hence the weird file extension.
# It messes up scripts at other times.
# __all__ = [
# "cgenerator",
# "check_spec_links",
# "comment_convert",
# "conventions",
# "docgenerator",
# "extensionmetadocgenerator",
# "generator",
# "genRef",
# "genspec",
# "genvk",
# "hostsyncgenerator",
# "indexExt",
# "make_ext_dependency",
# "pygenerator",
# "reflib",
# "reflow_count",
# "reflow",
# "reg",
# "test_check_spec_links_api_specific",
# "test_check_spec_links",
# "test_entity_db",
# "validitygenerator",
# "vkapi",
# "vkconventions",
# "xml_consistency",
# "spec_tools",
# ]