basis/tools/disassembler/disassembler-docs.factor

   1 IN: tools.disassembler\r
   2 USING: help.markup help.syntax sequences.private ;\r
   3 \r
   4 HELP: disassemble\r
   5 { $values { "obj" "a word or a pair of addresses" } }\r
   6 { $description "Disassembles either a compiled word definition or an arbitrary memory range (in the case " { $snippet "obj" } " is a pair of integers)." }\r
   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." } ;\r
   8 \r
   9 ARTICLE: "tools.disassembler" "Disassembling words"\r
  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."\r
  11 $nl\r
  12 "See also " { $vocab-link "compiler.tree.debugger" } " and " { $vocab-link "compiler.cfg.debugger" } "."\r
  13 $nl\r
  14 { $subsections disassemble } ;\r
  15 \r
  16 ABOUT: "tools.disassembler"\r