diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2023-08-23 16:09:00 -0400 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2023-08-23 16:09:00 -0400 |
| commit | 37df2e956d3c6b0008b72dfe915d36c63f694e30 (patch) | |
| tree | 76381f236e8f58f10934d21a8fa3b88f27105cd3 /python/architecture.py | |
| parent | 0d5fe9ec8963a26361b8bf1af17e029afc87f952 (diff) | |
small clarification on APIs that descibe max_instruction_length
Diffstat (limited to 'python/architecture.py')
| -rw-r--r-- | python/architecture.py | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/python/architecture.py b/python/architecture.py index 9c5cb64d..623c3284 100644 --- a/python/architecture.py +++ b/python/architecture.py @@ -1370,7 +1370,7 @@ class Architecture(metaclass=_ArchitectureMetaClass): UnresolvedBranch Branch destination is an unknown address ===================== =================================================== - :param str data: max_instruction_length bytes from the binary at virtual address ``addr`` + :param str data: a maximum of max_instruction_length bytes from the binary at virtual address ``addr`` :param int addr: virtual address of bytes in ``data`` :return: the InstructionInfo for the current instruction :rtype: InstructionInfo @@ -1384,7 +1384,7 @@ class Architecture(metaclass=_ArchitectureMetaClass): .. note:: Architecture subclasses should implement this method. - :param str data: max_instruction_length bytes from the binary at virtual address ``addr`` + :param str data: a maximum of max_instruction_length bytes from the binary at virtual address ``addr`` :param int addr: virtual address of bytes in ``data`` :return: a tuple containing the InstructionTextToken list and length of bytes decoded :rtype: tuple(list(InstructionTextToken), int) @@ -1409,7 +1409,7 @@ class Architecture(metaclass=_ArchitectureMetaClass): .. note:: Architecture subclasses should implement this method. - :param str data: max_instruction_length bytes from the binary at virtual address ``addr`` + :param str data: a maximum of max_instruction_length bytes from the binary at virtual address ``addr`` :param int addr: virtual address of bytes in ``data`` :param LowLevelILFunction il: The function the current instruction belongs to :return: the length of the current instruction @@ -2312,7 +2312,7 @@ class CoreArchitecture(Architecture): .. note:: The instruction info object should always set the InstructionInfo.length to the instruction length, \ and the branches of the proper types should be added if the instruction is a branch. - :param bytes data: max_instruction_length bytes from the binary at virtual address ``addr`` + :param bytes data: a maximum of max_instruction_length bytes from the binary at virtual address ``addr`` :param int addr: virtual address of bytes in ``data`` :return: the InstructionInfo for the current instruction :rtype: InstructionInfo @@ -2340,7 +2340,7 @@ class CoreArchitecture(Architecture): ``get_instruction_text`` returns a list of InstructionTextToken objects for the instruction at the given virtual address ``addr`` with data ``data``. - :param bytes data: max_instruction_length bytes from the binary at virtual address ``addr`` + :param bytes data: a maximum of max_instruction_length bytes from the binary at virtual address ``addr`` :param int addr: virtual address of bytes in ``data`` :return: an InstructionTextToken list for the current instruction :rtype: list(InstructionTextToken) @@ -2367,7 +2367,7 @@ class CoreArchitecture(Architecture): This is used to analyze arbitrary data at an address, if you are working with an existing binary, you likely want to be using :func:`Function.get_low_level_il_at`. - :param bytes data: max_instruction_length bytes from the binary at virtual address ``addr`` + :param bytes data: a maximum of max_instruction_length bytes from the binary at virtual address ``addr`` :param int addr: virtual address of bytes in ``data`` :param LowLevelILFunction il: The function the current instruction belongs to :return: the length of the current instruction |