aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/Documentation/options.md
diff options
authorLuc Van Oostenryck <luc.vanoostenryck@gmail.com>2017-11-13 14:16:10 +0100
committerLuc Van Oostenryck <luc.vanoostenryck@gmail.com>2017-11-13 14:16:10 +0100
commit1f6cd6fe94fc440a9bbd9c2f1070bd016e550be4 (patch)
tree73d5dee14c2d20e92b37b868ae3e12fb8d3b8cc3 /Documentation/options.md
parent5d7a65b06e8f8d42f80a046950e8f990d149b48e (diff)
parent555217d63d01f31d6322d475e33b5912a5926169 (diff)
downloadsparse-dev-1f6cd6fe94fc440a9bbd9c2f1070bd016e550be4.tar.gz
Merge branch 'dump-ir' into tip
Diffstat (limited to 'Documentation/options.md')
-rw-r--r--Documentation/options.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/Documentation/options.md b/Documentation/options.md
new file mode 100644
index 00000000..14698a98
--- /dev/null
+++ b/Documentation/options.md
@@ -0,0 +1,29 @@
+# Options
+
+This file is a complement of man page for sparse but meant
+for options not to be used by sparse itself but by the other
+tools.
+
+## Developer options:
+
+### Select the passes
+
+* '-f\<name-of-the-pass\>[-disable|-enable|=last]'
+
+ If '=last' is used, all passes after the specified one are disabled.
+ By default all passes are enabled.
+
+ The passes currently understood are:
+ * 'mem2reg'
+ * 'optim'
+
+### Internal Representation
+
+* '-fdump-ir[=\<pass\>[,\<pass\>...]]'
+
+ Dump the IR at each of the given passes.
+
+ The passes currently understood are:
+ * 'linearize'
+ * 'mem2reg'
+ * 'final'