]> gitweb.factorcode.org Git - factor.git/commitdiff
stack-checker.dependencies: docs
authorBjörn Lindqvist <bjourne@gmail.com>
Sat, 26 Nov 2016 15:09:16 +0000 (16:09 +0100)
committerBjörn Lindqvist <bjourne@gmail.com>
Mon, 28 Nov 2016 01:04:28 +0000 (02:04 +0100)
basis/stack-checker/dependencies/dependencies-docs.factor [new file with mode: 0644]

diff --git a/basis/stack-checker/dependencies/dependencies-docs.factor b/basis/stack-checker/dependencies/dependencies-docs.factor
new file mode 100644 (file)
index 0000000..f281215
--- /dev/null
@@ -0,0 +1,24 @@
+USING: help.markup help.syntax ;
+IN: stack-checker.dependencies
+
+HELP: +definition+
+{ $class-description "Word that indicates that the dependency is a definition dependency. It is a dependency among two words in which one word depends on the definition of the another. For example, if two words are defined as " { $snippet ": o ( -- ) i ;" } " and " { $snippet ": i ( -- ) ; inline" } ", then 'o' has a definition dependency to 'i' because 'i' is inline. If the definition of 'i' changes 'o' must be recompiled." } ;
+
+HELP: dependencies
+{ $var-description "Words that the current quotation depends on." } ;
+
+ARTICLE: "stack-checker.dependencies" "Definition Dependency Management"
+"This vocab manages dependency data during stack checking of words. All dependencies are divided into three types:"
+{ $subsections
+  +conditional+
+  +definition+
+  +effect+
+}
+"Temporary state:"
+{ $subsections
+  conditional-dependencies
+  dependencies
+  generic-dependencies
+} ;
+
+ABOUT: "stack-checker.dependencies"