status-im/Vulkan-Docs
2
0
Fork 0
mirror of https://github.com/status-im/Vulkan-Docs.git synced 2025-02-25 04:25:12 +00:00
Code Issues Projects Releases Wiki Activity
Vulkan-Docs/.gitlab/issue_templates/Release checklist.md
Jon Leech 59750fe4c7 Change log for August 25, 2019 Vulkan 1.1.121 spec update: 
* Update release number to 121.

Github Issues:

  * Add missing `structextends` attribute in `vk.xml` for
    slink:VkPhysicalDevicePipelineExecutablePropertiesFeaturesKHR (public
    issue 1018).
  * Change attributes of flink:vkCmdCopyAccelerationStructureNV,
    flink:vkCmdWriteAccelerationStructuresPropertiesNV,
    flink:vkCmdBuildAccelerationStructureNV, and flink:vkCmdTraceRaysNV to
    require that these commands execute outside renderpasses (public issue
    1021).
  * Add an issue to the `<<VK_EXT_buffer_device_address>>` appendix
    discussing the introduction of new names and aliasing by equivalent old
    names (public pull request 1024).

Internal Issues:

  * Protect the `VK_KHR_sampler_mirror_clamp_to_edge` extension with
    asciidoctor conditionals, and remove it from the core-only specification
    builds, where it had previously been force-included in the Makefile. It
    is now treated like any other extension (internal issue 1776).
  * Edit some asciidoctor anchor names starting with `features-features-` to
    just start with `features-`, since the old chapters was split into 3
    pieces. There are still some mild naming inconsistencies with anchors
    which may be addressed in the future (internal issue 1792).
  * Add `KHR` alias for the non-suffixed extension token
    ename:VK_SAMPLER_ADDRESS_MODE_MIRROR_CLAMP_TO_EDGE, for compatibility
    with naming rules for extensions (internal issue 1796).
  * Clarify requirements for external memory in NOTEs for
    sname:VkExternalMemoryBufferCreateInfo, and valid usage statements for
    flink:vkBindBufferMemory, slink:VkBindBufferMemoryInfo,
    flink:vkBindImageMemory, and slink:VkBindImageMemoryInfo (internal merge
    request 3301).
  * Make extension version numbers in `vk.xml` and extension appendices
    consistent. In a few cases, we could not recover history at this
    granularity, and left the summary of a version's change undefined
    (internal merge request 3323).
  * Fix invocation of `CodeInlineMacro` in the Ruby extension backing the
    `code:` macro, which was delegating to the wrong base class (internal
    merge request 3331).
  * Modify `reg.py` to do a better job of recognizing equivalent <enum>
    definitions.
  * Add a `sortorder` attribute to XML feature and extension tags.

New Extensions

  * `<<VK_AMD_device_coherent_memory>>`
2019-08-25 03:57:09 -07:00

3.0 KiB
Raw Permalink Blame History

Vulkan Feature Development Checklist Template

This template captures checklists for the stages of development that a Vulkan KHR extension passes through as it moves from development to ratification and release. You should create an issue from this template when the extension draft is stable and there is reasonable consensus in the working group that it is on a path to ratification.

Edit the template to suit the extension you are considering (and to delete the italicized instructions). Delete any requirements that are not relevant; for example, an extension that has no language dependencies will not need SPIR-V / GLSL / HLSL items, and an EXT GLSL extension will not require Promoter ratification.

Requirements may be waived by vote of the working group, provided that a 2/3 majority of non-abstaining vote are in favor.

Preconditions for Call for Votes (CfV)

A formal CfV is issued following agreement at a Tuesday meeting that a vote should be held at the following Tuesday meeting. Preconditions for a CfV are as follows; "specification stable" means that there are no MRs in flight that modify behavior defined by the extension and its dependencies. Delete any of the following preconditions that are not relevant to the extension in question

  • VAP consulted to the extent the WG considers appropriate
  • Vulkan API specification merged and stable in devel (MR)
  • API spec naming review complete
  • CTS tests approved with three passing implementations (gerrit cl)
  • SPIR-V specification merged and stable (MR)
  • GLSL specification merged and stable (MR)

Preconditions for submission to Promoters

  • WG vote to submit passed with a 3/4 majority
  • Submission package available for Promoter review

Preconditions for creating public release issue on GitHub

Delete any of the following preconditions that are not relevant to the extension in question. Enter target dates for software artifacts where indicated. Note that these are targets and may slip.

  • Vulkan specification ratified by Promoters
  • SPIR-V specification ratified by Promoters
  • GLSL specification ratified by Promoters
  • GLSLang implementation release schedule agreed: target target-date
  • Validation layer implementation approved to merge
  • Loader support approved to merge (for instance extensions)
  • HLSL mapping defined
  • HLSL mapping supported in GLSLang
  • HLSL mapping supported in DXC
  • CTS release schedule agreed: target target-date
  • SDK release schedule agreed: target target-date
  • SPIR-V tools implementation schedule agreed: target target-date
  • Public release schedule agreed: target target-date

Preconditions for closing this issue

  • Public release issue items checked off and issue closed

Additional (Optional) Items

These additional items are recommended for creation at some point during or after the release, but are not required at any point.

  • Usage Examples
  • Usage Advice