aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/Documentation/dev-options.rst
diff options
Diffstat (limited to 'Documentation/dev-options.rst')
-rw-r--r--Documentation/dev-options.rst45
1 files changed, 45 insertions, 0 deletions
diff --git a/Documentation/dev-options.rst b/Documentation/dev-options.rst
new file mode 100644
index 00000000..1f213afe
--- /dev/null
+++ b/Documentation/dev-options.rst
@@ -0,0 +1,45 @@
+sparse - extra options for developers
+=====================================
+
+SYNOPSIS
+--------
+``tools`` [`options`]... `file.c``
+
+DESCRIPTION
+-----------
+
+This file is a complement of sparse's man page meant to
+document options only useful for development on sparse itself.
+
+OPTIONS
+-------
+
+.. option:: -fdump-ir=pass,[pass]
+
+ Dump the IR at each of the given passes.
+
+ The passes currently understood are:
+
+ * ``linearize``
+ * ``mem2reg``
+ * ``final``
+
+ The default pass is ``linearize``.
+
+.. option:: -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``
+
+.. option:: -vdead
+
+ Add ``OP_DEATHNOTE`` annotations to dead pseudos.
+
+.. option:: -ventry
+
+ Dump the IR after all optimization passes.