compiler: Fix help-lint for @bjourne's recent awesome docs.

db4
Doug Coleman 2015-01-17 14:02:59 -08:00
parent b4e9334d04
commit ceebc1d6c1
4 changed files with 9 additions and 7 deletions

View File

@ -2,5 +2,5 @@ USING: compiler.cfg compiler.cfg.linear-scan.allocation help.markup
help.syntax sequences ;
HELP: (allocate-registers)
{ $values { "unhandled-intervals" "stuff" } { "unhandled-sync-points" "stuff" } }
{ $values { "unhandled-min-heap" "stuff" } }
{ $description "Register allocation works by emptying the unhandled intervals and sync points." } ;

View File

@ -1,16 +1,18 @@
USING: assocs compiler.cfg compiler.cfg.instructions compiler.cfg.registers
compiler.cfg.parallel-copy.private help.markup help.syntax math sequences ;
USING: assocs arrays compiler.cfg compiler.cfg.instructions
compiler.cfg.parallel-copy.private compiler.cfg.registers
help.markup help.syntax kernel math quotations sequences ;
IN: compiler.cfg.parallel-copy
HELP: process-to-do
{ $values { "b" object } { "temp" quotation } { "quot" quotation } }
{ $description "Note that we check if b = loc(b), not b = loc(pred(b)) as the paper suggests. Confirmed by one of the authors at http://www.reddit.com/comments/93253/some_lecture_notes_on_ssa_form/c0bco4f" } ;
HELP: parallel-copy
{ $values { "mapping" { $link assoc } " of { dst src } virtual register pairs" } }
{ $values { "mapping" { $link assoc } " of { dst src } virtual register pairs" } { "insns" array } }
{ $description "Creates " { $link ##copy } " instructions." } ;
HELP: parallel-copy-rep
{ $values { "mapping" { $link assoc } " of { dst src } virtual register pairs" } }
{ $values { "mapping" { $link assoc } " of { dst src } virtual register pairs" } { "insns" array } }
{ $description "Creates " { $link ##copy } " instructions." } ;
ARTICLE: "compiler.cfg.parallel-copy" "Parallel copy"

View File

@ -44,7 +44,7 @@ HELP: height-changes
{ $description "Converts a " { $link current-height } " tuple to 0-2 stack height change instructions." }
{ $examples
{ $example
"USING: compiler.cfg.stacks.local ;"
"USING: compiler.cfg.stacks.local prettyprint ;"
"T{ current-height { emit-d 4 } { emit-r -2 } } height-changes ."
"{ T{ ##inc-d { n 4 } } T{ ##inc-r { n -2 } } }"
}

View File

@ -21,7 +21,7 @@ HELP: ds-drop
{ $description "Used to signal to the stack analysis that the datastacks height is decreased by one." } ;
HELP: ds-store
{ $values { "vreg" "a " { $link sequence } " of vregs." } }
{ $values { "vregs" "a " { $link sequence } " of vregs." } }
{ $description "Registers that a sequence of vregs are stored at at each corresponding index of the data stack." } ;
HELP: rs-store