Add missing documentation for FORGPREP_INEXT and FORGPREP_NEXT (#1933)

Added documentation for FORGPREP_INEXT and FORGPREP_NEXT regarding the D
argument, which is used as the jump offset to the corresponding FORGLOOP
instruction.
This commit is contained in:
Amy Wysocka 2025-07-31 17:54:37 +02:00 committed by GitHub
parent 66202dc4ac
commit eaab9c4363
Signed by: DevComp
GPG key ID: B5690EEEBB952194

View file

@ -298,6 +298,7 @@ enum LuauOpcode
// FORGPREP_INEXT: prepare FORGLOOP with 2 output variables (no AUX encoding), assuming generator is luaB_inext, and jump to FORGLOOP // FORGPREP_INEXT: prepare FORGLOOP with 2 output variables (no AUX encoding), assuming generator is luaB_inext, and jump to FORGLOOP
// A: target register (see FORGLOOP for register layout) // A: target register (see FORGLOOP for register layout)
// D: jump offset (-32768..32767)
LOP_FORGPREP_INEXT, LOP_FORGPREP_INEXT,
// FASTCALL3: perform a fast call of a built-in function using 3 register arguments // FASTCALL3: perform a fast call of a built-in function using 3 register arguments
@ -310,6 +311,7 @@ enum LuauOpcode
// FORGPREP_NEXT: prepare FORGLOOP with 2 output variables (no AUX encoding), assuming generator is luaB_next, and jump to FORGLOOP // FORGPREP_NEXT: prepare FORGLOOP with 2 output variables (no AUX encoding), assuming generator is luaB_next, and jump to FORGLOOP
// A: target register (see FORGLOOP for register layout) // A: target register (see FORGLOOP for register layout)
// D: jump offset (-32768..32767)
LOP_FORGPREP_NEXT, LOP_FORGPREP_NEXT,
// NATIVECALL: start executing new function in native code // NATIVECALL: start executing new function in native code