fix more typos in docs.
parent
7d628b833d
commit
a92d67fcb2
|
@ -154,7 +154,7 @@ ARTICLE: "c-pointers" "Passing pointers to C functions"
|
|||
ARTICLE: "c-boxes" "C value boxes"
|
||||
"Sometimes it is useful to create a byte array storing a single C value, like a struct with a single field. A pair of utility words exist to make this more convenient:"
|
||||
{ $subsections <ref> deref }
|
||||
"These words can be used to in conjuction with, or instead of, " { $link with-out-parameters } " to handle \"out-parameters\". For example, if a function is declared in the following way:"
|
||||
"These words can be used to in conjunction with, or instead of, " { $link with-out-parameters } " to handle \"out-parameters\". For example, if a function is declared in the following way:"
|
||||
{ $code
|
||||
"FUNCTION: int do_foo ( int* a )"
|
||||
}
|
||||
|
|
|
@ -53,7 +53,7 @@ HELP: ##alien-indirect
|
|||
|
||||
HELP: ##allot
|
||||
{ $class-description
|
||||
"An instruction for allocating memory in the nursery. Usually the instruction is preceeded by " { $link ##check-nursery-branch } " which checks that there is enough room in the nursery to allocate. It has the following slots:"
|
||||
"An instruction for allocating memory in the nursery. Usually the instruction is preceded by " { $link ##check-nursery-branch } " which checks that there is enough room in the nursery to allocate. It has the following slots:"
|
||||
{ $table
|
||||
{ { $slot "dst" } { "Register to put the pointer to the memory in." } }
|
||||
{ { $slot "size" } { "Number of bytes to allocate." } }
|
||||
|
|
|
@ -12,7 +12,7 @@ HELP: destruct-ssa
|
|||
{ $description "Main entry point for the SSA destruction compiler pass." } ;
|
||||
|
||||
ARTICLE: "compiler.cfg.ssa.destruction" "SSA Destruction"
|
||||
"SSA destruction compiler pass. It is preceeded by " { $vocab-link "compiler.cfg.save-contexts" } " and followed by " { $vocab-link "compiler.cfg.linear-scan" } "."
|
||||
"SSA destruction compiler pass. It is preceded by " { $vocab-link "compiler.cfg.save-contexts" } " and followed by " { $vocab-link "compiler.cfg.linear-scan" } "."
|
||||
$nl
|
||||
"Because of the design of the register allocator, this pass has three peculiar properties."
|
||||
{ $list
|
||||
|
|
|
@ -38,7 +38,7 @@ HELP: gc-map-needed?
|
|||
|
||||
HELP: gc-root-offsets
|
||||
{ $values { "gc-map" gc-map } { "offsets" sequence } }
|
||||
{ $description "Gets the offets of all roots in a gc-map. The " { $link cfg } " variable must have been set and the stack-frame slot been initialized." } ;
|
||||
{ $description "Gets the offsets of all roots in a gc-map. The " { $link cfg } " variable must have been set and the stack-frame slot been initialized." } ;
|
||||
|
||||
HELP: serialize-gc-maps
|
||||
{ $values { "byte-array" byte-array } }
|
||||
|
|
|
@ -31,7 +31,7 @@ HELP: n-bit-version-of
|
|||
ARTICLE: "cpu.x86.assembler.operands" "CPU x86 registers and memory operands"
|
||||
"Indirect operand constructors for various addressing formats:"
|
||||
{ $subsections [] [RIP+] [+] [++] [+*2+] [+*4+] [+*8+] }
|
||||
"Register correspondances:"
|
||||
"Register correspondences:"
|
||||
{ $subsections
|
||||
8-bit-version-of
|
||||
16-bit-version-of
|
||||
|
|
|
@ -34,7 +34,7 @@ HELP: secure-config
|
|||
|
||||
HELP: <secure-config>
|
||||
{ $values { "config" secure-config } }
|
||||
{ $description "Creates a new secure socket configration with default values." } ;
|
||||
{ $description "Creates a new secure socket configuration with default values." } ;
|
||||
|
||||
ARTICLE: "ssl-key-file" "The key file and password"
|
||||
"The " { $snippet "key-file" } " and " { $snippet "password" } " slots of a " { $link secure-config } " can be set to a private key file in PEM format. These slots are required for secure servers, and also for clients when client-side authentication is used." ;
|
||||
|
|
|
@ -3,7 +3,7 @@ IN: multiline
|
|||
|
||||
HELP: STRING:
|
||||
{ $syntax "STRING: name\nfoo\n;" }
|
||||
{ $description "Forms a multiline string literal, or 'here document' stored in the word called name. A semicolon is used to signify the end, and that semicolon must be on a line by itself, not preceeded or followed by any whitespace. The string will have newlines in between lines but not at the end, unless there is a blank line before the semicolon." } ;
|
||||
{ $description "Forms a multiline string literal, or 'here document' stored in the word called name. A semicolon is used to signify the end, and that semicolon must be on a line by itself, not preceded or followed by any whitespace. The string will have newlines in between lines but not at the end, unless there is a blank line before the semicolon." } ;
|
||||
|
||||
HELP: /*
|
||||
{ $syntax "/* comment */" }
|
||||
|
|
|
@ -66,7 +66,7 @@ HELP: user-groups
|
|||
HELP: with-effective-group
|
||||
{ $values
|
||||
{ "string/id/f" "a string, a group id, or f" } { "quot" quotation } }
|
||||
{ $description "Sets the effective group name and calls the quotation. Restores the effective group name on success or on error after the call. If the first parameter is " { $link f } ", the quotation is called as the current user." } ;
|
||||
{ $description "Sets the effective group name and calls the quotation. Restors the effective group name on success or on error after the call. If the first parameter is " { $link f } ", the quotation is called as the current user." } ;
|
||||
|
||||
HELP: with-group-cache
|
||||
{ $values
|
||||
|
|
|
@ -5,7 +5,7 @@ HELP: invalid-slot-name
|
|||
{ $values { "name" string } }
|
||||
{ $description "Throws an " { $link invalid-slot-name } " error." }
|
||||
{ $error-description "Thrown by " { $link POSTPONE: TUPLE: } " and " { $link POSTPONE: ERROR: } " if a suspect token appears as a slot name." }
|
||||
{ $notes "The suspect tokens are chosen so that the following code raises this parse error, instead of silently greating a tuple with garbage slots:"
|
||||
{ $notes "The suspect tokens are chosen so that the following code raises this parse error, instead of silently creating a tuple with garbage slots:"
|
||||
{ $code
|
||||
"TUPLE: my-mistaken-tuple slot-a slot-b"
|
||||
""
|
||||
|
|
|
@ -77,7 +77,7 @@ DEFER: if
|
|||
|
||||
: ? ( ? true false -- true/false )
|
||||
! 'if' and '?' can be defined in terms of each other
|
||||
! because the JIT special-cases an 'if' preceeded by
|
||||
! because the JIT special-cases an 'if' preceded by
|
||||
! two literal quotations.
|
||||
rot [ drop ] [ nip ] if ; inline
|
||||
|
||||
|
|
|
@ -193,7 +193,7 @@ HELP: subset?
|
|||
|
||||
HELP: set=
|
||||
{ $values { "set1" set } { "set2" set } { "?" boolean } }
|
||||
{ $description "Tests if both sets contain the same elements, disregrading order and duplicates." } ;
|
||||
{ $description "Tests if both sets contain the same elements, disregarding order and duplicates." } ;
|
||||
|
||||
HELP: gather
|
||||
{ $values
|
||||
|
|
|
@ -119,7 +119,7 @@ HELP: ⊥
|
|||
{ $class-description "Logical contradiction. This statement is unconditionally false." } ;
|
||||
|
||||
HELP: ⋀
|
||||
{ $class-description "Logical conjuction (AND)." } ;
|
||||
{ $class-description "Logical conjunction (AND)." } ;
|
||||
|
||||
HELP: ⋁
|
||||
{ $class-description "Logical disjunction (OR)." } ;
|
||||
|
|
Loading…
Reference in New Issue