Author: David Spickett Date: 2025-12-10T11:38:20Z New Revision: 16aa79d444a32c8d8b4f2e60d58f785e47178987
URL: https://github.com/llvm/llvm-project/commit/16aa79d444a32c8d8b4f2e60d58f785e47178987 DIFF: https://github.com/llvm/llvm-project/commit/16aa79d444a32c8d8b4f2e60d58f785e47178987.diff LOG: [lldb][docs] Fix table formatting in bytecode docs Me adding extra backticks caused all these to be misaligned. This didn't show up on the docs buildbot but did error in CI on a later PR of mine. Added: Modified: lldb/docs/resources/formatterbytecode.rst Removed: ################################################################################ diff --git a/lldb/docs/resources/formatterbytecode.rst b/lldb/docs/resources/formatterbytecode.rst index c1b9f931d18f1..edaf56a1122e2 100644 --- a/lldb/docs/resources/formatterbytecode.rst +++ b/lldb/docs/resources/formatterbytecode.rst @@ -65,42 +65,42 @@ Control flow These manipulate the control stack and program counter. Both ``if`` and ``ifelse`` expect a ``UInt`` at the top of the data stack to represent the condition. -======== ========== ============================================================ - Opcode Mnemonic Description --------- ---------- ------------------------------------------------------------ - 0x10 ``{`` push a code block address onto the control stack - -- ``}`` (technically not an opcode) syntax for end of code block - 0x11 ``if`` ``(UInt -> )`` pop a block from the control stack, - if the top of the data stack is nonzero, execute it - 0x12 ``ifelse`` ``(UInt -> )`` pop two blocks from the control stack, if - the top of the data stack is nonzero, execute the first, - otherwise the second. - 0x13 ``return`` pop the entire control stack and return -======== ========== ============================================================ +======== ============ ============================================================ + Opcode Mnemonic Description +-------- ------------ ------------------------------------------------------------ + 0x10 ``{`` push a code block address onto the control stack + -- ``}`` (technically not an opcode) syntax for end of code block + 0x11 ``if`` ``(UInt -> )`` pop a block from the control stack, + if the top of the data stack is nonzero, execute it + 0x12 ``ifelse`` ``(UInt -> )`` pop two blocks from the control stack, if + the top of the data stack is nonzero, execute the first, + otherwise the second. + 0x13 ``return`` pop the entire control stack and return +======== ============ ============================================================ Literals for basic types ~~~~~~~~~~~~~~~~~~~~~~~~ -======== =========== ============================================================ - Opcode Mnemonic Description --------- ----------- ------------------------------------------------------------ - 0x20 ``123u`` ``( -> UInt)`` push an unsigned 64-bit host integer - 0x21 ``123`` ``( -> Int)`` push a signed 64-bit host integer - 0x22 ``"abc"`` ``( -> String)`` push a UTF-8 host string - 0x23 ``@strlen`` ``( -> Selector)`` push one of the predefined function - selectors. See ``call``. -======== =========== ============================================================ +======== ============= ============================================================ + Opcode Mnemonic Description +-------- ------------- ------------------------------------------------------------ + 0x20 ``123u`` ``( -> UInt)`` push an unsigned 64-bit host integer + 0x21 ``123`` ``( -> Int)`` push a signed 64-bit host integer + 0x22 ``"abc"`` ``( -> String)`` push a UTF-8 host string + 0x23 ``@strlen`` ``( -> Selector)`` push one of the predefined function + selectors. See ``call``. +======== ============= ============================================================ Conversion operations ~~~~~~~~~~~~~~~~~~~~~ -======== =========== ================================================================ - Opcode Mnemonic Description --------- ----------- ---------------------------------------------------------------- - 0x2a ``as_int`` ``( UInt -> Int)`` reinterpret a UInt as an Int - 0x2b ``as_uint`` ``( Int -> UInt)`` reinterpret an Int as a UInt - 0x2c ``is_null`` ``( Object -> UInt )`` check an object for null ``(object ? 0 : 1)`` -======== =========== ================================================================ +======== ============= ================================================================ + Opcode Mnemonic Description +-------- ------------- ---------------------------------------------------------------- + 0x2a ``as_int`` ``( UInt -> Int)`` reinterpret a UInt as an Int + 0x2b ``as_uint`` ``( Int -> UInt)`` reinterpret an Int as a UInt + 0x2c ``is_null`` ``( Object -> UInt )`` check an object for null ``(object ? 0 : 1)`` +======== ============= ================================================================ Arithmetic, logic, and comparison operations @@ -142,33 +142,33 @@ For security reasons the list of functions callable with ``call`` is predefined. Method is one of a predefined set of *Selectors*. -==== ============================ =================================================== ================================== -Sel. Mnemonic Stack Effect Description ----- ---------------------------- --------------------------------------------------- ---------------------------------- -0x00 ``summary`` ``(Object @summary -> String)`` ``SBValue::GetSummary`` -0x01 ``type_summary`` ``(Object @type_summary -> String)`` ``SBValue::GetTypeSummary`` -0x10 ``get_num_children`` ``(Object @get_num_children -> UInt)`` ``SBValue::GetNumChildren`` -0x11 ``get_child_at_index`` ``(Object UInt @get_child_at_index -> Object)`` ``SBValue::GetChildAtIndex`` -0x12 ``get_child_with_name`` ``(Object String @get_child_with_name -> Object)`` ``SBValue::GetChildAtIndex`` -0x13 ``get_child_index`` ``(Object String @get_child_index -> UInt)`` ``SBValue::GetChildIndex`` -0x15 ``get_type`` ``(Object @get_type -> Type)`` ``SBValue::GetType`` -0x16 ``get_template_argument_type`` ``(Object UInt @get_template_argument_type -> Type)`` ``SBValue::GetTemplateArgumentType`` -0x17 ``cast`` ``(Object Type @cast -> Object)`` ``SBValue::Cast`` -0x20 ``get_value`` ``(Object @get_value -> Object)`` ``SBValue::GetValue`` -0x21 ``get_value_as_unsigned`` ``(Object @get_value_as_unsigned -> UInt)`` ``SBValue::GetValueAsUnsigned`` -0x22 ``get_value_as_signed`` ``(Object @get_value_as_signed -> Int)`` ``SBValue::GetValueAsSigned`` -0x23 ``get_value_as_address`` ``(Object @get_value_as_address -> UInt)`` ``SBValue::GetValueAsAddress`` -0x40 ``read_memory_byte`` ``(UInt @read_memory_byte -> UInt)`` ``Target::ReadMemory`` -0x41 ``read_memory_uint32`` ``(UInt @read_memory_uint32 -> UInt)`` ``Target::ReadMemory`` -0x42 ``read_memory_int32`` ``(UInt @read_memory_int32 -> Int)`` ``Target::ReadMemory`` -0x43 ``read_memory_uint64`` ``(UInt @read_memory_uint64 -> UInt)`` ``Target::ReadMemory`` -0x44 ``read_memory_int64`` ``(UInt @read_memory_int64 -> Int)`` ``Target::ReadMemory`` -0x45 ``read_memory_address`` ``(UInt @read_memory_uint64 -> UInt)`` ``Target::ReadMemory`` -0x46 ``read_memory`` ``(UInt Type @read_memory -> Object)`` ``Target::ReadMemory`` -0x50 ``fmt`` ``(String arg0 ... @fmt -> String)`` ``llvm::format`` -0x51 ``sprintf`` ``(String arg0 ... sprintf -> String)`` ``sprintf`` -0x52 ``strlen`` ``(String strlen -> String)`` ``strlen in bytes`` -==== ============================ =================================================== ================================== +==== =============================== ====================================================== ====================================== +Sel. Mnemonic Stack Effect Description +---- ------------------------------- ------------------------------------------------------ -------------------------------------- +0x00 ``summary`` ``(Object @summary -> String)`` ``SBValue::GetSummary`` +0x01 ``type_summary`` ``(Object @type_summary -> String)`` ``SBValue::GetTypeSummary`` +0x10 ``get_num_children`` ``(Object @get_num_children -> UInt)`` ``SBValue::GetNumChildren`` +0x11 ``get_child_at_index`` ``(Object UInt @get_child_at_index -> Object)`` ``SBValue::GetChildAtIndex`` +0x12 ``get_child_with_name`` ``(Object String @get_child_with_name -> Object)`` ``SBValue::GetChildAtIndex`` +0x13 ``get_child_index`` ``(Object String @get_child_index -> UInt)`` ``SBValue::GetChildIndex`` +0x15 ``get_type`` ``(Object @get_type -> Type)`` ``SBValue::GetType`` +0x16 ``get_template_argument_type`` ``(Object UInt @get_template_argument_type -> Type)`` ``SBValue::GetTemplateArgumentType`` +0x17 ``cast`` ``(Object Type @cast -> Object)`` ``SBValue::Cast`` +0x20 ``get_value`` ``(Object @get_value -> Object)`` ``SBValue::GetValue`` +0x21 ``get_value_as_unsigned`` ``(Object @get_value_as_unsigned -> UInt)`` ``SBValue::GetValueAsUnsigned`` +0x22 ``get_value_as_signed`` ``(Object @get_value_as_signed -> Int)`` ``SBValue::GetValueAsSigned`` +0x23 ``get_value_as_address`` ``(Object @get_value_as_address -> UInt)`` ``SBValue::GetValueAsAddress`` +0x40 ``read_memory_byte`` ``(UInt @read_memory_byte -> UInt)`` ``Target::ReadMemory`` +0x41 ``read_memory_uint32`` ``(UInt @read_memory_uint32 -> UInt)`` ``Target::ReadMemory`` +0x42 ``read_memory_int32`` ``(UInt @read_memory_int32 -> Int)`` ``Target::ReadMemory`` +0x43 ``read_memory_uint64`` ``(UInt @read_memory_uint64 -> UInt)`` ``Target::ReadMemory`` +0x44 ``read_memory_int64`` ``(UInt @read_memory_int64 -> Int)`` ``Target::ReadMemory`` +0x45 ``read_memory_address`` ``(UInt @read_memory_uint64 -> UInt)`` ``Target::ReadMemory`` +0x46 ``read_memory`` ``(UInt Type @read_memory -> Object)`` ``Target::ReadMemory`` +0x50 ``fmt`` ``(String arg0 ... @fmt -> String)`` ``llvm::format`` +0x51 ``sprintf`` ``(String arg0 ... sprintf -> String)`` ``sprintf`` +0x52 ``strlen`` ``(String strlen -> String)`` ``strlen in bytes`` +==== =============================== ====================================================== ====================================== Byte Code ~~~~~~~~~ @@ -212,16 +212,16 @@ This is followed by one or more dictionary values that immediately follow each o The possible function signatures are: -========= ====================== ========================== -Signature Mnemonic Stack Effect ---------- ---------------------- -------------------------- - 0x00 ``@summary`` ``(Object -> String)`` - 0x01 ``@init`` ``(Object -> Object+)`` - 0x02 ``@get_num_children`` ``(Object+ -> UInt)`` - 0x03 ``@get_child_index`` ``(Object+ String -> UInt)`` - 0x04 ``@get_child_at_index`` ``(Object+ UInt -> Object)`` - 0x05 ``@get_value`` ``(Object+ -> String)`` -========= ====================== ========================== +========= ========================= ============================== +Signature Mnemonic Stack Effect +--------- ------------------------- ------------------------------ + 0x00 ``@summary`` ``(Object -> String)`` + 0x01 ``@init`` ``(Object -> Object+)`` + 0x02 ``@get_num_children`` ``(Object+ -> UInt)`` + 0x03 ``@get_child_index`` ``(Object+ String -> UInt)`` + 0x04 ``@get_child_at_index`` ``(Object+ UInt -> Object)`` + 0x05 ``@get_value`` ``(Object+ -> String)`` +========= ========================= ============================== If not specified, the init function defaults to an empty function that just passes the Object along. Its results may be cached and allow common prep work to be done for an Object that can be reused by subsequent calls to the other methods. This way subsequent calls to ``@get_child_at_index`` can avoid recomputing shared information, for example. _______________________________________________ lldb-commits mailing list [email protected] https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
