basis/tools/disassembler/disassembler-docs.factor

   1 IN: tools.disassembler
   2 USING: help.markup help.syntax sequences.private ;
   3
   4 HELP: disassemble
   5 { $values { "obj" "a word or a pair of addresses" } }
   6 { $description "Disassembles either a compiled word definition or an arbitrary memory range (in the case " { $snippet "obj" } " is a pair of integers)." }
   7 { $notes "In some cases the Factor compiler emits data inline with code, which can confuse the disassembler. This occurs in words which call " { $link dispatch } ", where the jump table addresses are compiled inline." } ;
   8
   9 ARTICLE: "tools.disassembler" "Disassembling words"
  10 "The " { $vocab-link "tools.disassembler" } " vocabulary provides support for disassembling compiled word definitions. It uses the " { $snippet "libudis86" } " library on x86-32 and x86-64, and " { $snippet "gdb" } " on PowerPC."
  11 $nl
  12 "See also " { $vocab-link "compiler.tree.debugger" } " and " { $vocab-link "compiler.cfg.debugger" } "."
  13 $nl
  14 { $subsections disassemble } ;
  15
  16 ABOUT: "tools.disassembler"