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

tools.profiler.counting: rename help article

db4
Joe Groff 2011-10-31 20:00:51 -07:00
parent eb749bb535
commit 6d3d8392d1
4 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
basis/tools/annotations/annotations-docs.factor
View File

@ -49,7 +49,7 @@ HELP: watch-vars
HELP: add-timing
{ $values { "word" word } }
{ $description "Adds timing code to a word, which records its total running time, including that of words it calls, on every invocation." }
{ $see-also "timing" "profiling" } ;
{ $see-also "timing" "tools.profiler.counting" } ;
HELP: reset-word-timing
{ $description "Resets the word timing table." } ;
@ -58,4 +58,4 @@ HELP: word-timing.
{ $description "Prints the word timing table." } ;
HELP: cannot-annotate-twice
{ $error-description "Thrown when attempting to annotate a word that's already been annotated. If a word already has an annotation such as a watch or a breakpoint, you must first " { $link reset } " the word before adding another annotation." } ;
{ $error-description "Thrown when attempting to annotate a word that's already been annotated. If a word already has an annotation such as a watch or a breakpoint, you must first " { $link reset } " the word before adding another annotation." } ;

4
basis/tools/profiler/counting/counting-docs.factor
View File

@ -11,7 +11,7 @@ ARTICLE: "profiler-limitations" "Profiler limitations"
"Tail-recursive loops will only count the initial invocation of the word, not every tail call."
} ;
ARTICLE: "profiling" "Profiling code"
ARTICLE: "tools.profiler.counting" "Call-counting profiler"
"The " { $vocab-link "tools.profiler.counting" } " vocabulary implements a simple call counting profiler."
$nl
"Quotations can be passed to a combinator which calls them with the profiler enabled:"
@ -27,7 +27,7 @@ $nl
}
{ $see-also "ui.tools.profiler" "tools.annotations" "timing" } ;
ABOUT: "profiling"
ABOUT: "tools.profiler.counting"
HELP: counters
{ $values { "words" "a sequence of words" } { "alist" "an association list mapping words to integers" } }

2
basis/tools/time/time-docs.factor
View File

@ -10,7 +10,7 @@ ARTICLE: "timing" "Timing code and collecting statistics"
"A lower-level word puts timings on the stack, instead of printing:"
{ $subsections benchmark }
"You can also read the system clock directly; see " { $link "system" } "."
{ $see-also "profiling" "tools.annotations" "calendar" } ;
{ $see-also "tools.profiler.counting" "tools.annotations" "calendar" } ;
ABOUT: "timing"

6
basis/ui/tools/profiler/profiler-docs.factor
View File

@ -2,14 +2,14 @@ IN: ui.tools.profiler
USING: help.markup help.syntax ui.operations ui.commands help.tips ;
ARTICLE: "ui.tools.profiler" "UI profiler tool"
"The " { $vocab-link "ui.tools.profiler" } " vocabulary implements a graphical tool for viewing profiling results (see " { $link "profiling" } ")."
"The " { $vocab-link "ui.tools.profiler" } " vocabulary implements a graphical tool for viewing profiling results (see " { $link "tools.profiler.counting" } ")."
$nl
"To use the profiler, enter a piece of code in the listener input area and press " { $operation com-profile } "."
$nl
"Clicking on a vocabulary in the vocabulary list narrows down the word list to only include words from that vocabulary. The sorting options control the order of elements in the vocabulary and word lists. The search fields narrow down the list to only include words or vocabularies whose names contain a substring."
$nl
"Consult " { $link "profiling" } " for details about the profiler itself." ;
"Consult " { $link "tools.profiler.counting" } " for details about the profiler itself." ;
TIP: "Press " { $operation com-profile } " to run the code in the input field with profiling enabled (" { $link "ui.tools.profiler" } ")." ;
ABOUT: "ui.tools.profiler"
ABOUT: "ui.tools.profiler"