Changeset 15579


Ignore:
Timestamp:
05/23/22 06:23:39 (9 months ago)
Author:
Mark Evenson
Message:

Edit docstrings around disassembler machinery

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/abcl/src/org/armedbear/lisp/disassemble.lisp

    r15578 r15579  
    3434
    3535(defvar *disassembler-function* nil
    36   "The currently used function for CL:DISASSEMBLE. 
    37 
    38 Available disassemblers are configured by pushing a strategy to SYSTEM:*DISASSEMBLERS*. 
    39 
    40 SYSTEM:CHOOSE-DISASSEMBLER selects a current strategy from this list .")
     36  "The underlying function last used for CL:DISASSEMBLE or nil if not invoked
     37
     38Available disassemblers are configured by pushing a strategy to
     39SYSTEM:*DISASSEMBLERS*.  The function SYSTEM:CHOOSE-DISASSEMBLER is
     40used to select a current strategy from this list of strategies.")
    4141
    4242(defvar *disassemblers*
    4343  `((:system-javap . disassemble-class-bytes))
    44   "Methods of invoking CL:DISASSEMBLE consisting of a enumeration of (keyword function) pairs
    45 
    46 The pairs (keyword function) contain a keyword identifying this
    47 particulat disassembler, and a symbol designating function takes a
    48 object to disassemble.
    49 
    50 Use SYS:CHOOSE-DISASSEMBLER to install a given disassembler as the one
    51 used by CL:DISASSEMBLE.  Additional disassemblers/decompilers are
    52 packaged in the ABCL-INTROSPECT contrib.
    53 
    54 The intial default is :javap using the javap command line tool which
    55 is part of the Java Developement Kit.
     44  "Methods of invoking CL:DISASSEMBLE consisting of a list of (KEYWORD FUNCTION) pairs
     45
     46The pairs (KEYWORD FUNCTION) contain a KEYWORD uniquely identifying a
     47particular disassembler and a SYMBOL designating its invocation function.
     48
     49The KEYWORD values are used by SYS:CHOOSE-DISASSEMBLER to install a
     50given disassembler as the one used by CL:DISASSEMBLE.  Additional
     51disassemblers/decompilers are packaged in the ABCL-INTROSPECT contrib.
     52
     53The initial default is :SYSTEM-JAVAP which attempts to invoke the
     54javap command line tool shipped as part of the Java Developement Kit
     55which may or may not be installed locally.
    5656")
    5757
     
    5959  "Report current disassembler that would be used by CL:DISASSEMBLE
    6060
    61 With optional keyword NAME, select the associated disassembler from
    62 SYS:*DISASSEMBLERS*."
     61When the optional keyword NAME is specified, select the associated
     62disassembler from SYS:*DISASSEMBLERS* for future invocations of
     63CL:DISASSEMBLE."
    6364  (flet ((sane-disassembler-p (disassembler)
    6465           (and disassembler
Note: See TracChangeset for help on using the changeset viewer.