status-im/Vulkan-Docs
2
0
Fork 0
mirror of https://github.com/status-im/Vulkan-Docs.git synced 2025-02-08 12:34:05 +00:00
Code Issues Projects Releases Wiki Activity
Vulkan-Docs/.gitlab/issue_templates/Release checklist.md
Jon Leech 894211de5f (The previous commit didn't actually include internal gitlab changes 
since 1.1.89; fixed now).

Change log for October 28, 2018 Vulkan 1.1.90 spec update:

  * Update release number to 90.

Public Issues:

  * Tag flink:vkQueueWaitIdle as `externsync` in `vk.xml` (public pull
    request 815).
  * Update README (public pull request 834).
  * `VK_NV_framebuffer_mixed_samples` and `VK_AMD_mixed_attachment_samples`
    had confusing and contradictory valid usage statements when read in the
    all-extensions spec build. Change them to explicitly mention which
    extension each is for (public issue Vulkan-ValidationLayers/issues/353).

Internal Issues:

  * Update `COPYING.md` to clarify how externally generated Vulkan
    Specifications (for translations, annotations, or other reasons) must be
    copyrighted, and acknowledge the Exception Clause on the `vk.xml`
    license (internal issue 1079).
  * Specify that flink:vkGetPhysicalDeviceImageFormatProperties may: return
    pname:maxMipLevels 1 if the format is ycbcr (internal issue 1361).
  * Clarify previously underspecified language for
    flink:vkCmdPushConstants::pname:pStageFlags regarding use of push
    constants across multiple pipelines (internal issue 1403).
  * Fix typo in XML/headers for
    ename:VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_EXPLICIT_CREATE_INFO_EXT,
    which was previously
    etext:VK_STRUCTURE_TYPE_IMAGE_EXCPLICIT_DRM_FORMAT_MODIFIER_CREATE_INFO_EXT
    (internal issue 1428).
  * Fix markup of equations that were sporadically breaking the
    `optimize-pdf` step of PDF generation, due (apparently) to inconsistent
    treatment of unwrapped multicharacter terms by different LaTeX parsers
    (internal issue 1435).
  * For the <<memory-model-synchronizes-with synchronizes-with>> memory
    model relation cases involving a release barrier plus relaxed atomic
    write, treat the atomic as if it were a release atomic and allow the
    acquire side to read from its hypothetical release sequence. This is
    more consistent with how C++ defines synchronization for release fences
    (internal issue cross-api/memory-model#72).
  * Minor editorial changes to the <<memory-model, memory model>> appendix
    based on external feedback.
2018-10-28 23:53:18 -07:00

2.8 KiB
Raw 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 of the working group, provided that a 2/3 majority of non-abstaining vote are in favor.

Release checklist for VK_KHR_extension_name_here

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
  • CTS tests approved with three passing implementations
  • Vulkan specification merged and stable in devel
  • SPIR-V specification merged and stable
  • GLSL specification merged and stable

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

  • Vulkan specification ratified by Promoters
  • SPIR-V specification ratified by Promoters
  • GLSL specification ratified by Promoters
  • GLSLang implementation approved to merge
  • Marketing summary written and approved by Vulkan WG and PR team
  • Validation layer implementation approved to merge
  • HLSL mapping defined
  • HLSL mapping supported in GLSLang
  • HLSL mapping supported in DXC
  • CTS tests approved to merge
  • SPIR-V tools implementation approved to merge
  • Loader support approved to merge (for instance extensions)
  • Public release approved by Vulkan WG

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