Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add texture_builtin_notes.md #4127

Merged
merged 2 commits into from
Jan 4, 2025
Merged

Conversation

greggman
Copy link
Contributor

@greggman greggman commented Jan 2, 2025

I'm not sure this belongs here. Maybe it should be moved to /docs or maybe it shouldn't exist in the repo at all. I thought about just making an issue in gpuweb/gpuweb/issues and posting each failure as a reply under that issue.

Thoughts?

@greggman
Copy link
Contributor Author

greggman commented Jan 2, 2025

@toji
Copy link
Member

toji commented Jan 2, 2025

I think this is a valuable thing to have in the repo. I'll let others weigh in on whether it belongs here or in /docs, though I'm leaning towards keeping it where you've got it (close to the tests that it's relevant to.)

------------------------------------------------------------------------------------------------------------
## gpu:Intel Comet Lake S UHD Graphics 630 (8086:9bc5-31.0.101.2127)
## os:Windows-10
## affected: `textureGather` with cube and cube-arrays.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: confusing in the rendered version because it looks like there are two empty sections. Maybe use

## A<br>B<br>C

or just put the details inside the section body

# Texture Builtin Notes

These are known failures for various GPUs. If you find more, please add to this list so developers
can be aware what does and does not work.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we want this to be discoverable by developers then maybe it should be on some github wiki or something. I'm not sure where is a good place for it.

Otherwise having it here is fine, though I'd add a mention of this file in one of the READMEs or test description files so it's not "unreferenced" from the test suite.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wiki works for me.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I started a wiki here

https://github.com/gpuweb/gpuweb/wiki/Texture-Builtins-Issues

I thought about making one page per issue and linking them from the that page. Or I can just past them all in that one page.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally I think one page is better, github wikis don't really handle having many pages that well.

As for this PR, it'll still useful to add a link to that wiki page in one of the readmes/descriptions.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I posted the issue is the wiki but unfortunately it's not really readable as github gives the wiki a maximum width. Maybe the wiki should just link to this and/or, maybe we could make it available at https://gpuweb.github.io/cts/standalone/src/webgpu/shader/execution/expression/call/builtin/texture_builtin_notes.md

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, shame.

Linking is fine, we could have a gpuweb wiki page for errata, and link directly to the .md file in this repo. Don't think there's any need to make it work on gpuweb.github.io.

@greggman greggman force-pushed the texture-builtin-notes branch from 296f897 to 139d565 Compare January 4, 2025 06:44
@greggman greggman enabled auto-merge (squash) January 4, 2025 06:44
@greggman greggman merged commit 3faf2bf into gpuweb:main Jan 4, 2025
1 check passed
@greggman greggman deleted the texture-builtin-notes branch January 4, 2025 07:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants