summaryrefslogtreecommitdiff
path: root/docs/pages/1 - Intro to Mill.md
diff options
context:
space:
mode:
authorJoseph K. Strauss <joseph.k.strauss@gmail.com>2018-08-08 09:36:17 -0400
committerLi Haoyi <haoyi.sg@gmail.com>2018-08-08 21:36:17 +0800
commit87dfb308db0a83a3443fe71127716411474b0b69 (patch)
treeac8170997f74766ef982ba451191d3d3562acb36 /docs/pages/1 - Intro to Mill.md
parent5ad6d60e6665f53860927c8a383bc6348e89c5e4 (diff)
downloadmill-87dfb308db0a83a3443fe71127716411474b0b69.tar.gz
mill-87dfb308db0a83a3443fe71127716411474b0b69.tar.bz2
mill-87dfb308db0a83a3443fe71127716411474b0b69.zip
Visualize Plan (#404)
* Make necessary import changes * Refactor to allow calling internally w/o println * Refactor to allow multiple visualize modes * Add new visualizaPlan grap entire plan * Remove and alphabetize imports * Document visualizePlan
Diffstat (limited to 'docs/pages/1 - Intro to Mill.md')
-rw-r--r--docs/pages/1 - Intro to Mill.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/pages/1 - Intro to Mill.md b/docs/pages/1 - Intro to Mill.md
index a3300595..49ac64da 100644
--- a/docs/pages/1 - Intro to Mill.md
+++ b/docs/pages/1 - Intro to Mill.md
@@ -558,6 +558,29 @@ compilation output:
![VisualizeCompile.svg](VisualizeCompile.svg)
+### visualizePlan
+
+```bash
+$ mill show visualizePlan moduledefs.allSourceFiles
+[
+ ".../out/visualizePlan/dest/out.txt",
+ ".../out/visualizePlan/dest/out.dot",
+ ".../out/visualizePlan/dest/out.json",
+ ".../out/visualizePlan/dest/out.png",
+ ".../out/visualizePlan/dest/out.svg"
+]
+```
+
+`mill show visualizePlan` is similar except that it shows a graph of the entire
+build plan, including dependencies not directly resolved by the query. Targets
+directly resolved are shown with a solid border, and dependencies are shown with
+a dotted border.
+
+The above command generates the following diagram:
+
+![VisualizePlan.svg](VisualizePlan.svg)
+
+Currently, visualizePlan does not support graphs that contain external modules.
### clean