subcmand asmfmt -> disasmflavor

rocky · rocky · commit 2f5a4b1d2fab · 2025-06-22T11:12:40.000-04:00
This matches gdb more closely
diff --git a/docs/commands/data/disassemble.rst b/docs/commands/data/disassemble.rst
@@ -47,4 +47,4 @@ Disassmble Examples
 
 .. seealso::
 
- :ref:`help syntax arange <syntax_arange>` for the specification of an address range :ref:`deparse <deparse>`, :ref:`list <list>`, :ref:`info pc <info_pc>`, and :ref:`set asmfmt <set_asmfmt>`.
+ :ref:`help syntax arange <syntax_arange>` for the specification of an address range :ref:`deparse <deparse>`, :ref:`list <list>`, :ref:`info pc <info_pc>`, and :ref:`set asmfmt <set_disasmflavor>`.
diff --git a/docs/commands/files/list.rst b/docs/commands/files/list.rst
@@ -23,8 +23,8 @@ in addition you can also use:
   - a '-' for the lines before the last list
   - a '+' for the lines after the last list
 
-Examples:
-+++++++++
+List Examples:
+++++++++++++++
 
 ::
 
diff --git a/docs/commands/set.rst b/docs/commands/set.rst
@@ -21,12 +21,12 @@ environment settings with the :ref:`show <show>` command.
 .. toctree::
    :maxdepth: 1
 
-   set/asmfmt
    set/autoeval
    set/autolist
    set/autopc
    set/autopython
    set/basename
+   set/disasmflavor
    set/cmdtrace
    set/confirm
    set/dbg_trepan
diff --git a/docs/commands/set/asmfmt.rst b/docs/commands/set/asmfmt.rst
diff --git a/docs/commands/set/patsub.rst b/docs/commands/set/patsub.rst
@@ -16,8 +16,8 @@ the mount-point for /home/rocky/project. You are running the code
 from the docker container, but debugging this from outside of that.
 
 
-Example:
-++++++++
+Set Substitution Pattern Example:
++++++++++++++++++++++++++++++++++
 
 ::
 
diff --git a/docs/commands/set/style.rst b/docs/commands/set/style.rst
@@ -13,8 +13,8 @@ use `set style none`.
 To list the available pygments styles inside the debugger, omit the style name.
 
 
-Examples:
-+++++++++
+Set Style Examples:
++++++++++++++++++++
 
 ::
 
diff --git a/docs/commands/set/substitute.rst b/docs/commands/set/substitute.rst
@@ -14,8 +14,8 @@ tokenization, so we have added a hack to ignore `<frozen .. >`.
 
 So, for frozen files like `<frozen importlib._bootstrap>`, use `importlib._bootstrap`
 
-Examples:
-+++++++++
+Set Substitute Examples:
+++++++++++++++++++++++++
 
 ::
 
diff --git a/docs/commands/show.rst b/docs/commands/show.rst
@@ -18,7 +18,6 @@ Show
 
    show/aliases
    show/args
-   show/asmfmt
    show/autoeval
    show/autolist
    show/autopc
@@ -28,6 +27,7 @@ Show
    show/confirm
    show/dbg_trepan
    show/different
+   show/disasmflavor
    show/events
    show/flush
    show/highlight
diff --git a/docs/commands/show/asmfmt.rst b/docs/commands/show/asmfmt.rst
diff --git a/docs/commands/show/disasmflavor.rst b/docs/commands/show/disasmflavor.rst
@@ -0,0 +1,33 @@
+.. index:: show; disasmflavor
+.. _show_disasmflavor:
+
+Show DisasmFlavor
+-----------------
+
+**show disasmflavor**
+
+ Show the disassembly format style used in the ``disassemble`` command.
+
+The style of style to use in disassembly:
+
+``classic``:
+  fields: line, marker offset, opcode operand
+
+``extended``:
+  like above, but we try harder to get operand information from previous instructions
+
+``bytes``:
+   like classic but we show the instruction bytes after the offset
+
+``extended-bytes``:
+   ``bytes`` format along with *extended* format
+
+Show disasmflavor Example:
+++++++++++++++++++++++++++
+
+::
+    show disasmflavor
+
+.. seealso::
+
+   :ref:`set_disasmflavor <set_disasmflavor>`
diff --git a/docs/commands/stack/backtrace.rst b/docs/commands/stack/backtrace.rst
@@ -22,8 +22,8 @@ evaluation or source-line listing.
    -h | --help    - give this help
 
 
-Examples:
-+++++++++
+Backtrace Examples:
++++++++++++++++++++
 
 ::
 
diff --git a/docs/commands/stack/frame.rst b/docs/commands/stack/frame.rst
@@ -21,8 +21,8 @@ parsing limitations, the position expression has to be seen as a single
 blank-delimited parameter. That is, the expression `(5*3)-1` is okay
 while `(5 * 3) - 1)` isn't.
 
-Examples:
-+++++++++
+Frame Examples:
++++++++++++++++
 
 ::
 
diff --git a/docs/commands/support/alias.rst b/docs/commands/support/alias.rst
@@ -13,8 +13,8 @@ that would otherwise be ambiguous. For example, by default we make ``s``
 be an alias of ``step`` to force it to be used. Without the alias, ``s``
 might be ``step``, ``show``, or ``set`` among others
 
-Example:
-++++++++
+Alias Examples:
++++++++++++++++
 
 ::
 
diff --git a/docs/syntax/range.rst b/docs/syntax/range.rst
@@ -20,8 +20,8 @@ offset.
 A number is just a decimal number. An offset is a number prefaced with "+" and
 indicates the number to increment the line number found in *first*.
 
-Examples
---------
+List Range Examples
+--------------------
 
 ::
 
diff --git a/test/unit/processor/test_proc_subcmd.py b/test/unit/processor/test_proc_subcmd.py
@@ -1,6 +1,7 @@
 """Unit test for trepan.processor.subcmd"""
 import unittest
 
+from typing import Tuple
 from trepan.processor.command.base_cmd import DebuggerCommand
 from trepan.processor.command.mock import MockDebugger
 from trepan.processor.subcmd import Subcmd
@@ -27,6 +28,8 @@ def run(self, args):
 class MySubcommand:
     """Doc string for test testing subcommand"""
 
+    aliases: Tuple = tuple()
+
     def __init__(self):
         self.name = "testing"
         return
diff --git a/trepan/lib/default.py b/trepan/lib/default.py
@@ -48,7 +48,7 @@
     "annotate": 0,
 
     # Format style to use in showing disassembly
-    "asmfmt": "extended",
+    "disasmflavor": "extended",
 
     # Eval as Python the unrecognized debugger commands?
     "autoeval": True,
diff --git a/trepan/processor/command/base_subcmd.py b/trepan/processor/command/base_subcmd.py
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 #   Copyright (C) 2009-2010, 2012-2013, 2015-2016, 2020,
-#   2023-2024 Rocky Bernstein
+#   2023-2025 Rocky Bernstein
 #
 #   This program is free software: you can redistribute it and/or modify
 #   it under the terms of the GNU General Public License as published by
@@ -25,6 +25,8 @@
 import re
 
 import columnize
+
+from typing import Tuple
 from pygments.console import colorize
 
 from trepan.lib.complete import complete_token
@@ -115,18 +117,18 @@ def msg_nocr(self, msg):
         """Convenience short-hand for self.debugger.intf[-1].msg_nocr"""
         return self.debugger.intf[-1].msg_nocr(msg)
 
-    aliases: tuple = ()
+    aliases: Tuple[str] = tuple()
     name: str = "YourSubCommandName"
 
     def rst_msg(self, text):
         """Convenience short-hand for self.proc.rst_msg(text)"""
         return self.proc.rst_msg(text)
 
-    def run(self):
+    def run(self, *args):
         """The method that implements the debugger command.
         Help on the command comes from the docstring of this method.
         """
-        raise NotImplementedError(NotImplementedMessage)
+        raise NotImplementedError(NotImplementedMessage, *args)
 
     def section(self, message, opts={}):
         if "plain" != self.settings["highlight"]:
diff --git a/trepan/processor/command/disassemble.py b/trepan/processor/command/disassemble.py
@@ -90,7 +90,7 @@ class DisassembleCommand(DebuggerCommand):
     disassemble that.
 
     Assembly output format is be controlled by the setting of `set
-    asmfmt`. Output formats are those described the `xdis` `pydisasm`
+    disasmflavor`. Output formats are those described the `xdis` `pydisasm`
     disassembler.
 
 
@@ -110,7 +110,7 @@ class DisassembleCommand(DebuggerCommand):
     See also:
     ---------
 
-    `help syntax arange`, `deparse`, `list`, `info pc`, `set asmfmt`.
+    `help syntax arange`, `deparse`, `list`, `info pc`, `set disasmflavor`.
 
     """
 
@@ -132,7 +132,7 @@ def run(self, args):
             "start_offset": None,
             "end_offset": None,
             "relative_pos": False,
-            "asm_format": self.settings["asmfmt"],
+            "asm_format": self.settings["disasmflavor"],
         }
 
         curframe = proc.curframe
diff --git a/trepan/processor/command/set_subcmd/disasmflavor.py b/trepan/processor/command/set_subcmd/disasmflavor.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#   Copyright (C) 2020, 2021, 2024 Rocky Bernstein
+#   Copyright (C) 2020, 2021, 2024, 2025 Rocky Bernstein
 #
 #   This program is free software: you can redistribute it and/or modify
 #   it under the terms of the GNU General Public License as published by
@@ -19,10 +19,10 @@
 from trepan.lib.complete import complete_token
 
 
-class SetAsmFmt(DebuggerSubcommand):
-    """**set asmfmt** {**classic** | **extended** | **bytes** | **extended-bytes**}
+class SetDisasmFlavor(DebuggerSubcommand):
+    """**set disasmflavor** {**classic** | **extended** | **bytes** | **extended-bytes**}
 
-    The style of format to use in disassembly:
+    The style of style to use in disassembly:
 
            classic:  fields: line, marker offset, opcode operand
            extended: above, but we try harder to get operand information from previous instructions
@@ -33,41 +33,42 @@ class SetAsmFmt(DebuggerSubcommand):
     Examples:
     --------
 
-        set asmfmt extended # this is the default
-        set asmfmt classic  # no highlight
+        set disasmflavor extended # this is the default
+        set disasmflavor classic  # no highlight
 
     See also:
     ---------
-    `show asmfmt`"""
+    `show disasmflavor`"""
 
     # Note: the "completion_choices" name is special and used by prompt_toolkit's completion
     completion_choices = ["classic", "extended", "extended-bytes", "bytes"]
 
+    aliases = ("disassembly-flavor",)  # This is not quite right.
     in_list = True
     max_args = 1
-    min_abbrev = len("asmf")
+    min_abbrev = len("disas")
     min_args = 0
-    short_help = "Set disassembly style"
+    short_help = "Set disassembly flavor"
 
     def complete(self, prefix):
-        return complete_token(SetAsmFmt.completion_choices, prefix)
+        return complete_token(SetDisasmFlavor.completion_choices, prefix)
 
     def get_format_type(self, arg):
         if not arg:
             return "extended"
-        if arg in SetAsmFmt.completion_choices:
+        if arg in SetDisasmFlavor.completion_choices:
             return arg
         else:
             self.errmsg(
-                f"Expecting one of: {', '.join(SetAsmFmt.completion_choices)}; got: {arg}."
+                f"Expecting one of: {', '.join(SetDisasmFlavor.completion_choices)}; got: {arg}."
             )
             return None
         pass
 
     def run(self, args):
         if len(args) == 0:
             self.section("disasembly style types: ")
-            self.msg(self.columnize_commands(SetAsmFmt.completion_choices))
+            self.msg(self.columnize_commands(SetDisasmFlavor.completion_choices))
             return
         format_type = self.get_format_type(args[0])
         if not format_type:
@@ -83,5 +84,5 @@ def run(self, args):
 if __name__ == "__main__":
     from trepan.processor.command.set_subcmd.__demo_helper__ import demo_run
 
-    demo_run(SetAsmFmt, ["classic"])
+    demo_run(SetDisasmFlavor, ["classic"])
     pass
diff --git a/trepan/processor/command/show_subcmd/disasmflavor.py b/trepan/processor/command/show_subcmd/disasmflavor.py
diff --git a/trepan/processor/subcmd.py b/trepan/processor/subcmd.py

Original file line number	Diff line number	Diff line change
`@@ -47,4 +47,4 @@ Disassmble Examples`
`47`	`47`
`48`	`48`	`.. seealso::`
`49`	`49`
`50`		- :ref:`help syntax arange <syntax_arange>` for the specification of an address range :ref:`deparse <deparse>`, :ref:`list <list>`, :ref:`info pc <info_pc>`, and :ref:`set asmfmt <set_asmfmt>`.
	`50`	+ :ref:`help syntax arange <syntax_arange>` for the specification of an address range :ref:`deparse <deparse>`, :ref:`list <list>`, :ref:`info pc <info_pc>`, and :ref:`set asmfmt <set_disasmflavor>`.