diff --git a/basis/compiler/cfg/dominance/dominance-docs.factor b/basis/compiler/cfg/dominance/dominance-docs.factor index 9a72ae6539..9cf5dc2346 100644 --- a/basis/compiler/cfg/dominance/dominance-docs.factor +++ b/basis/compiler/cfg/dominance/dominance-docs.factor @@ -7,7 +7,15 @@ HELP: dom-parents HELP: dom-children { $values { "bb" basic-block } { "seq" sequence } } -{ $description "Maps bb -> {bb' | idom(bb') = bb}" } ; +{ $description "Maps bb -> {bb' | idom(bb') = bb} or in other words, all basic blocks dominated by the given basic block." } ; + +HELP: dom-parent +{ $values { "bb" basic-block } { "bb'" basic-block } } +{ $description "The basic block dominating the given block." } ; + +HELP: needs-dominance +{ $values { "cfg" cfg } } +{ $description "Recalculates predecessor and dominance info for the given cfg." } ; ARTICLE: "compiler.cfg.dominance" "A Simple, Fast Dominance Algorithm" $nl "A Simple, Fast Dominance Algorithm" $nl @@ -15,6 +23,12 @@ ARTICLE: "compiler.cfg.dominance" "A Simple, Fast Dominance Algorithm" $nl "http://www.cs.rice.edu/~keith/EMBED/dom.pdf" $nl "Also, a nice overview is given in these lecture notes:" $nl -"http://llvm.cs.uiuc.edu/~vadve/CS526/public_html/Notes/4ssa.4up.pdf" ; +"http://llvm.cs.uiuc.edu/~vadve/CS526/public_html/Notes/4ssa.4up.pdf" +$nl +"To rebuild dominance information:" +{ $subsections needs-dominance } +"To read the dominance data:" +{ $subsections dom-children dom-parent } ; + ABOUT: "compiler.cfg.dominance"