steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: fixing smaller help-lint nitpicks

db4
Björn Lindqvist 2014-10-19 14:05:06 +02:00
parent 164af978ba
commit a617855aef
5 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
basis/compiler/cfg/builder/alien/params/params.factor
View File

@ -6,7 +6,7 @@ IN: compiler.cfg.builder.alien.params
SYMBOL: stack-params
GENERIC: alloc-stack-param ( reg -- n )
GENERIC: alloc-stack-param ( rep -- n )
M: object alloc-stack-param ( rep -- n )
stack-params get

5
basis/compiler/cfg/linear-scan/live-intervals/live-intervals-docs.factor
View File

@ -2,4 +2,9 @@ USING: help.markup help.syntax ;
IN: compiler.cfg.linear-scan.live-intervals
HELP: <live-interval>
{ $values
{ "vreg" "virtual register" }
{ "reg-class" "register class" }
{ "live-interval" live-interval-state }
}
{ $description "Creates a new live interval for a virtual register. Initially the range is empty." } ;

2
basis/compiler/cfg/stacks/local/local-docs.factor
View File

@ -18,7 +18,7 @@ HELP: translate-local-loc
{ $example
"USING: compiler.cfg.stacks.local compiler.cfg.registers namespaces prettyprint ;"
"T{ current-height { d 3 } } current-height set D 7 translate-local-loc ."
"D 4"
"T{ ds-loc { n 4 } }"
}
} ;

7
basis/cpu/architecture/architecture-docs.factor
View File

@ -136,7 +136,12 @@ HELP: return-regs
{ $description "What registers that will be used for function return values of which class." } ;
HELP: stack-cleanup
{ $values { "stack-size" integer } { "return" "a c type" } { "abi" abi } }
{ $values
{ "stack-size" integer }
{ "return" "a c type" }
{ "abi" abi }
{ "n" integer }
}
{ $description "Calculates how many bytes of stack space the caller of the procedure being constructed need to cleanup. For modern abi's the value is almost always 0." }
{ $examples
{ $unchecked-example

4
basis/stack-checker/alien/alien-docs.factor
View File

@ -26,7 +26,7 @@ HELP: param-prep-quot
} ;
HELP: callback-parameter-quot
{ $values { "params" alien-node-params } }
{ $values { "params" alien-node-params } { "quot" quotation } }
{ $description "Builds a quotation which coerces values on the stack to the required types for an alien callback. This word is essentially the opposite to " { $link param-prep-quot } "." }
{ $examples
{ $unchecked-example
@ -40,7 +40,7 @@ HELP: infer-alien-invoke
{ $description "Appends the necessary SSA nodes for performing an " { $link alien-invoke } " call to the IR tree being constructed." } ;
HELP: wrap-callback-quot
{ $values { "params" alien-node-params } { "quot" quotation } }
{ $values { "params" alien-node-params } { "quot" quotation } { "quot'" quotation } }
{ $description "Wraps the given quotation in protective packaging so that it becomes suitable to be used as an alien callback. That means that the parameters are unpacked from C types to Factor types and, if the callback returns something, the top data stack item is afterwards converted to a C compatible value." }
{ $examples
"Here a callback that returns the length of a " { $link c-string } " is wrapped:"