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

Specify [=debug label=]. #1240

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

kdashg
Copy link
Contributor

@kdashg kdashg commented Nov 19, 2020

  • We SHOULD preserve length/charset
  • We MUST NOT use labels in (WebGPU-implementation) heuristics
  • Note that there may be not clear mapping for a label.

Resolves #1211.


Preview | Diff

* We SHOULD preserve length/charset
* We MUST NOT use labels in (WebGPU-implementation) heuristics
* Note that there may be not clear mapping for a label.
</dl>


: <dfn dfn>Debug label</dfn>
Copy link
Contributor

Choose a reason for hiding this comment

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

optional nit: The :/:: syntax is shorthand for <dt>/<dd> and inserts an implicit <dl> wrapper if there isn't one. So in this case this should render like a <dl>. Maybe it would be better if it just looks like a paragraph? (Otherwise I kind of feel like it needs something before it, describing what the list is, like "has the following members:" above.)

:: A string provided for use by development tools (such as error/warning messages,
browser developer tools, or platform debugging utilities) to identify the underlying
[=internal object=], debug group, or debug marker to the developer.
It has no specified format, and implementations MUST NOT use label contents in heuristics.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: We don't normally all-caps the RFC 2119 words. Though it would be cool if they could be highlighted like in Vulkan....

:: A string provided for use by development tools (such as error/warning messages,
browser developer tools, or platform debugging utilities) to identify the underlying
[=internal object=], debug group, or debug marker to the developer.
It has no specified format, and implementations MUST NOT use label contents in heuristics.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: not just heuristics, it must not affect behavior at all.

Copy link
Contributor

Choose a reason for hiding this comment

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

nit: I think we use the "should not" wording because there's no way to enforce the "must not" behavior via tests.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think we can and should keep "must not" even though it's not enforceable.

@@ -513,6 +508,29 @@ interface mixin GPUObjectBase {
An internal slot holding the [=device=] which owns the [=internal object=].
</dl>

{{GPUObjectDescriptorBase}} has the following members:

<dl dfn-type=dict-member dfn-for=GPUObjectDescriptorBase>
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this moved? Seems like it should stay next to its IDL.



: <dfn dfn>Debug label</dfn>
:: A string provided for use by development tools (such as error/warning messages,
Copy link
Contributor

@kvark kvark Nov 20, 2020

Choose a reason for hiding this comment

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

reads slightly ambiguous to me: is the string provided by the dev tools, or used by the dev tools. May need to be reworded slightly

@Kangz
Copy link
Contributor

Kangz commented Feb 15, 2021

This looks stalled. Can the comments be addressed or should the PR be closed?

@kainino0x kainino0x added this to the V1.0 milestone Aug 25, 2022
@kainino0x kainino0x added the copyediting Pure editorial stuff (copyediting, *.bs file syntax, etc.) label Aug 25, 2022
ben-clayton pushed a commit to ben-clayton/gpuweb that referenced this pull request Sep 6, 2022
This CL adds unimplemented stubs for the `step` builtin.

Issue: gpuweb#1240
ben-clayton pushed a commit to ben-clayton/gpuweb that referenced this pull request Sep 6, 2022
@kainino0x kainino0x added the api WebGPU API label May 15, 2024
@kainino0x kainino0x modified the milestones: Milestone 0, Milestone 1 Jul 1, 2024
@kainino0x kainino0x added the moved-m0-to-m1 (TEMPORARY) items moved from M0 to M1 while trying to make M0 = requirements for CR label Jul 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api WebGPU API copyediting Pure editorial stuff (copyediting, *.bs file syntax, etc.) moved-m0-to-m1 (TEMPORARY) items moved from M0 to M1 while trying to make M0 = requirements for CR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Are implementations allowed to crush DOMString labels down to ASCII?
4 participants