From 804348287c12654c9d7650a6080b3c46ee1249d2 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Bj=C3=B6rn=20Lindqvist?= Date: Tue, 22 Sep 2015 06:52:04 +0200 Subject: [PATCH] Docs: fix a bunch of help-lint warnings --- .../linear-scan/live-intervals/live-intervals-docs.factor | 6 ------ basis/compiler/cfg/linear-scan/ranges/ranges-docs.factor | 4 ++-- basis/compiler/codegen/relocation/relocation-docs.factor | 5 +++-- basis/compiler/constants/constants-docs.factor | 1 + basis/compiler/tree/tree-docs.factor | 2 +- core/sequences/sequences-docs.factor | 3 ++- extra/fuel/help/help-docs.factor | 6 ++++++ 7 files changed, 15 insertions(+), 12 deletions(-) create mode 100644 extra/fuel/help/help-docs.factor diff --git a/basis/compiler/cfg/linear-scan/live-intervals/live-intervals-docs.factor b/basis/compiler/cfg/linear-scan/live-intervals/live-intervals-docs.factor index d761fe40f6..c6171189e9 100644 --- a/basis/compiler/cfg/linear-scan/live-intervals/live-intervals-docs.factor +++ b/basis/compiler/cfg/linear-scan/live-intervals/live-intervals-docs.factor @@ -72,12 +72,6 @@ HELP: live-interval-state { { $slot "uses" } { "sequence of insn# numbers which reference insructions that use the register in the live interval." } } - { - { $slot "reg-class" } - { "Register class of the interval, either " - { $link int-regs } " or " { $link float-regs } "." } - - } } } { $notes "The " { $slot "uses" } " and " { $slot "ranges" } " will never be empty because then the interval would be unused." } ; diff --git a/basis/compiler/cfg/linear-scan/ranges/ranges-docs.factor b/basis/compiler/cfg/linear-scan/ranges/ranges-docs.factor index 77aef69e01..0f2c38e10b 100644 --- a/basis/compiler/cfg/linear-scan/ranges/ranges-docs.factor +++ b/basis/compiler/cfg/linear-scan/ranges/ranges-docs.factor @@ -7,8 +7,8 @@ HELP: add-range HELP: intersect-range { $values - { "range1" pair } - { "range2" pair } + { "r1" pair } + { "r2" pair } { "n/f" { $link number } " or " { $link f } } } { $description "First index for the ranges intersection, or f if they don't intersect." } ; diff --git a/basis/compiler/codegen/relocation/relocation-docs.factor b/basis/compiler/codegen/relocation/relocation-docs.factor index 9a996b87a6..e4293c6368 100644 --- a/basis/compiler/codegen/relocation/relocation-docs.factor +++ b/basis/compiler/codegen/relocation/relocation-docs.factor @@ -1,5 +1,5 @@ -USING: byte-vectors compiler.constants cpu.architecture help.markup -help.syntax make vectors ; +USING: alien byte-arrays byte-vectors compiler.constants cpu.architecture +help.markup help.syntax make vectors ; IN: compiler.codegen.relocation HELP: relocation-table @@ -7,6 +7,7 @@ HELP: relocation-table { $see-also init-relocation } ; HELP: add-dlsym-parameters +{ $values { "symbol" byte-array } { "dll" dll } } { $description "Adds a pair of parameters for a reference to an external C function to the " { $link parameter-table } "." } ; HELP: add-relocation diff --git a/basis/compiler/constants/constants-docs.factor b/basis/compiler/constants/constants-docs.factor index 5ac2088a06..3d189432ed 100644 --- a/basis/compiler/constants/constants-docs.factor +++ b/basis/compiler/constants/constants-docs.factor @@ -2,6 +2,7 @@ USING: compiler.codegen.relocation help.markup help.syntax math vm ; IN: compiler.constants HELP: context-callstack-save-offset +{ $values { "n" integer } } { $description "Offset in bytes in the " { $link context } " struct to where the c callstack is saved." } ; HELP: rt-cards-offset diff --git a/basis/compiler/tree/tree-docs.factor b/basis/compiler/tree/tree-docs.factor index 275a82dd3e..e918964508 100644 --- a/basis/compiler/tree/tree-docs.factor +++ b/basis/compiler/tree/tree-docs.factor @@ -36,7 +36,7 @@ HELP: #declare { $class-description "SSA tree node emitted when " { $link declare } " declarations are encountered." } ; HELP: #enter-recursive -{ $class-description "This node works is placed first in the " { $slot "child" } " sequence for " { $link #recursive } " nodes and works like a header for it." } +{ $class-description "This node works is placed first in the 'child' " { $link sequence } " for " { $link #recursive } " nodes and works like a header for it." } { $see-also #recursive #return-recursive } ; HELP: #if diff --git a/core/sequences/sequences-docs.factor b/core/sequences/sequences-docs.factor index b6d219c5e9..3e9b159eb6 100644 --- a/core/sequences/sequences-docs.factor +++ b/core/sequences/sequences-docs.factor @@ -445,7 +445,8 @@ HELP: 2all? { $values { "seq1" sequence } { "seq2" sequence } { "quot" { $quotation ( ... elt1 elt2 -- ... ? ) } } { "?" boolean } } { $description "Tests the predicate pairwise against elements of " { $snippet "seq1" } " and " { $snippet "seq2" } ". If the sequences have different lengths, then only the smallest sequences items are compared with the other." } { $examples - { $example "USING: prettyprint sequences ;" + { $example + "USING: math prettyprint sequences ;" "{ 1 2 3 4 } { 2 4 6 8 } [ <= ] 2all? ." "t" } diff --git a/extra/fuel/help/help-docs.factor b/extra/fuel/help/help-docs.factor new file mode 100644 index 0000000000..c469eac0c0 --- /dev/null +++ b/extra/fuel/help/help-docs.factor @@ -0,0 +1,6 @@ +USING: fuel.help.private help.markup help.syntax strings ; +IN: fuel.help + +HELP: fuel-find-word +{ $values { "name" string } { "word/f" "word or f" } } +{ $description "Prefer to use search which takes the execution context into account. If that fails, fall back on a search of all words." } ; -- 2.34.1