From e095b54644614fd51445accb233d158f1fa4f7ff Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Lindqvist?= <bjourne@gmail.com>
Date: Sun, 26 Jul 2015 20:40:50 +0200
Subject: [PATCH] compiler.tree.escape-analysis.*: new doc files

---
 .../tree/escape-analysis/check/check-docs.factor      | 11 +++++++++++
 .../tree/escape-analysis/escape-analysis-docs.factor  |  7 +++++++
 .../tree/escape-analysis/escape-analysis.factor       |  4 +---
 .../tree/escape-analysis/nodes/nodes-docs.factor      | 11 +++++++++++
 4 files changed, 30 insertions(+), 3 deletions(-)
 create mode 100644 basis/compiler/tree/escape-analysis/check/check-docs.factor
 create mode 100644 basis/compiler/tree/escape-analysis/escape-analysis-docs.factor
 create mode 100644 basis/compiler/tree/escape-analysis/nodes/nodes-docs.factor

diff --git a/basis/compiler/tree/escape-analysis/check/check-docs.factor b/basis/compiler/tree/escape-analysis/check/check-docs.factor
new file mode 100644
index 0000000000..e766ffe9cd
--- /dev/null
+++ b/basis/compiler/tree/escape-analysis/check/check-docs.factor
@@ -0,0 +1,11 @@
+USING: help.markup help.syntax kernel sequences ;
+IN: compiler.tree.escape-analysis.check
+
+HELP: run-escape-analysis?
+{ $values { "nodes" sequence } { "?" boolean } }
+{ $description "Whether to run escape analysis on the nodes or not." } ;
+
+ARTICLE: "compiler.tree.escape-analysis.check"
+"Skipping escape analysis pass for code which does not allocate" ;
+
+ABOUT: "compiler.tree.escape-analysis.check"
diff --git a/basis/compiler/tree/escape-analysis/escape-analysis-docs.factor b/basis/compiler/tree/escape-analysis/escape-analysis-docs.factor
new file mode 100644
index 0000000000..a8a4c54426
--- /dev/null
+++ b/basis/compiler/tree/escape-analysis/escape-analysis-docs.factor
@@ -0,0 +1,7 @@
+USING: help.markup help.syntax ;
+IN: compiler.tree.escape-analysis
+
+ARTICLE: "compiler.tree.escape-analysis" "Escape analysis for tuple unboxing"
+"This pass must run after propagation" ;
+
+ABOUT: "compiler.tree.escape-analysis"
diff --git a/basis/compiler/tree/escape-analysis/escape-analysis.factor b/basis/compiler/tree/escape-analysis/escape-analysis.factor
index 5bcbb6a348..523afc75b8 100644
--- a/basis/compiler/tree/escape-analysis/escape-analysis.factor
+++ b/basis/compiler/tree/escape-analysis/escape-analysis.factor
@@ -9,9 +9,7 @@ USE: compiler.tree.escape-analysis.simple
 
 IN: compiler.tree.escape-analysis
 
-! This pass must run after propagation
-
-: escape-analysis ( node -- node )
+: escape-analysis ( nodes -- nodes )
     init-escaping-values
     H{ } clone allocations set
     H{ } clone slot-accesses set
diff --git a/basis/compiler/tree/escape-analysis/nodes/nodes-docs.factor b/basis/compiler/tree/escape-analysis/nodes/nodes-docs.factor
new file mode 100644
index 0000000000..5f8fc68125
--- /dev/null
+++ b/basis/compiler/tree/escape-analysis/nodes/nodes-docs.factor
@@ -0,0 +1,11 @@
+USING: compiler.tree help.markup help.syntax ;
+IN: compiler.tree.escape-analysis.nodes
+
+HELP: escape-analysis*
+{ $values { "node" node } }
+{ $description "Performs escape analysis for one SSA node." } ;
+
+ARTICLE: "compiler.tree.escape-analysis.nodes"
+"Per-node dispatch for escape analysis" ;
+
+ABOUT: "compiler.tree.escape-analysis.nodes"