Skip to content

Commit 550e79d

Browse files
authored
[spec] Add note to instruction index (#1528)
1 parent 429b2e3 commit 550e79d

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

document/core/appendix/gen-index-instructions.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,14 @@
2121
---------------------
2222
"""
2323

24+
FOOTER = """\
25+
26+
.. note::
27+
Multi-byte opcodes are given with the shortest possible encoding in the table.
28+
However, what is following the first byte is actually a :ref:`u32 <binary-uint>` with variable-length encoding
29+
and consequently has multiple possible representations.\
30+
"""
31+
2432
COLUMNS = [
2533
'Instruction',
2634
'Binary Opcode',
@@ -591,3 +599,4 @@ def Row(columns):
591599
print(Row(instr), file=f)
592600

593601
print(DIVIDER, file=f)
602+
print(FOOTER, file=f)

document/core/appendix/index-instructions.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -516,3 +516,8 @@ Instruction Binary Opcode
516516
:math:`\F64X2.\VCONVERT\K{\_low\_i32x4\_s}` :math:`\hex{FD}~~\hex{FE}~~\hex{01}` :math:`[\V128] \to [\V128]` :ref:`validation <valid-vcvtop>` :ref:`execution <exec-vcvtop>`, :ref:`operator <op-convert_s>`
517517
:math:`\F64X2.\VCONVERT\K{\_low\_i32x4\_u}` :math:`\hex{FD}~~\hex{FF}~~\hex{01}` :math:`[\V128] \to [\V128]` :ref:`validation <valid-vcvtop>` :ref:`execution <exec-vcvtop>`, :ref:`operator <op-convert_u>`
518518
================================================= ==================================== ============================================= ============================================= ==================================================================
519+
520+
.. note::
521+
Multi-byte opcodes are given with the shortest possible encoding in the table.
522+
However, what is following the first byte is actually a :ref:`u32 <binary-uint>` with variable-length encoding
523+
and consequently has multiple possible representations.

0 commit comments

Comments
 (0)