core/generator/fixup/fixup-docs.factor

   1 USING: help.syntax help.markup math kernel
   2 words strings alien ;
   3 IN: generator.fixup
   4
   5 HELP: frame-required
   6 { $values { "n" "a non-negative integer" } }
   7 { $description "Notify the code generator that the currently compiling code block needs a stack frame with room for at least " { $snippet "n" } " parameters." } ;
   8
   9 HELP: add-literal
  10 { $values { "obj" object } { "n" integer } }
  11 { $description "Adds a literal to the " { $link literal-table } ", if it is not already there, and outputs the index of the literal in the table. This literal can then be used as an argument for a " { $link rt-literal } " relocation with " { $link rel-fixup } "." } ;
  12
  13 HELP: rel-dlsym
  14 { $values { "name" string } { "dll" "a " { $link dll } " or " { $link f } } { "class" "a relocation class" } }
  15 { $description "Records that the most recently assembled instruction contains a reference to the " { $snippet "name" } " symbol from " { $snippet "dll" } ". The correct " { $snippet "class" } " to use depends on instruction formats."
  16 } ;