KhronosGroup / KhronosGroup/Vulkan-Docs

The "required format tables" aren't reflected in `vk.xml`

Open
#2,389 2 comments 0 reactions 1 assignee View on GitHub

@spencer-lunarg is already working on this.

Since Jul 10, 2024.

Dominant language
JavaScript
Stars
3.3k
Forks
549
Avg merge
5d 5h
Merged PRs (30d)
2

Description

Currently, the tables in the Formats chapter that associate required format properties with formats are hand-written and aren't reflected in any form in vk.xml. This means that, for example, we can't reliably write tools to ask questions like "What, if any, formats are required to support usage bits X and Y"?

The markdown tables are here:

https://github.com/KhronosGroup/Vulkan-Docs/blob/main/chapters/formats.adoc#required-format-support

Note that (even though nobody should be doing this!) even the markdown is hard to parse as there are embedded ifdef statements. I've done it, and I wish I hadn't. 😆

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.