Skip to content

Commit 39b9935

Browse files
authored
Clarify naming conventions for opaque types in debug info documentation. (#370)
Update 'Name' requirements to indicate it should be mangled in an implementation-defined manner to avoid clashes with user-defined names.
1 parent 8284229 commit 39b9935

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

nonsemantic/NonSemantic.Shader.DebugInfo.100.asciidoc

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ Version
5555
5656
[width="40%",cols="25,25"]
5757
|========================================
58-
| Last Modified Date | 2025-02-04
59-
| Revision | 12
58+
| Last Modified Date | 2025-11-19
59+
| Revision | 13
6060
|========================================
6161
6262
Dependencies
@@ -173,7 +173,8 @@ of the core SPIR-V specification. +
173173
Debug info for source language opaque types is represented by
174174
<<DebugTypeComposite,*DebugTypeComposite*>> without 'Members' operands.
175175
'Size' of the composite must be <<DebugInfoNone,*DebugInfoNone*>> and 'Name'
176-
must start with '@' symbol to avoid clashes with user defined names.
176+
should be mangled in an implementation-defined manner to avoid clashes with
177+
user-defined names.
177178

178179
Removing Instructions
179180
~~~~~~~~~~~~~~~~~~~~~
@@ -910,7 +911,8 @@ Describe a 'structure', 'class', or 'union' data type. The 'Result <id>' of this
910911
+
911912
*Note:* To represent a source language opaque type, this instruction must have no
912913
'Members' operands, 'Size' operand must be <<DebugInfoNone,*DebugInfoNone*>>,
913-
and 'Name' must start with '@' to avoid clashes with user defined names.
914+
and 'Name' should be mangled in an implementation-defined manner to avoid
915+
clashes with user-defined names.
914916

915917
| 14+ | 12 | '<id>' +
916918
'Result Type' | 'Result <id>' | '<id> Set'| 10
@@ -1857,5 +1859,6 @@ Revision History
18571859
can be equal to 'Column start' operand.
18581860
|1.00 Rev 11 |2024-10-08|Spencer Fricke |Fix using 'Scope' instead of 'Parent' operand name.
18591861
|1.00 Rev 12 |2025-02-04|Spencer Fricke |Clarify Line and Column operand should start at 1.
1862+
|1.00 Rev 13 |2025-11-19|Diego Novillo |Loosen name mangling rules to make them implementation-defined.
18601863
|========================================================
18611864

0 commit comments

Comments
 (0)