aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/Documentation/dev-options.md
diff options
Diffstat (limited to 'Documentation/dev-options.md')
-rw-r--r--Documentation/dev-options.md24
1 files changed, 16 insertions, 8 deletions
diff --git a/Documentation/dev-options.md b/Documentation/dev-options.md
index d4aa6aff..8b1b30bc 100644
--- a/Documentation/dev-options.md
+++ b/Documentation/dev-options.md
@@ -1,34 +1,42 @@
-# Options
+# 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.
-## Developer options:
+## DEVELOPER OPTIONS
-### Select the passes
-
-* `-f<name-of-the-pass>[-disable|-enable|=last]`
+-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`
-### Debugging
+### DEBUGGING
-* `-fdump-ir[=<pass>[,<pass>...]]`
+-fdump-ir[=pass[,pass...]]
Dump the IR at each of the given passes.
The passes currently understood are:
+
* `linearize`
* `mem2reg`
* `final`
-* `-v<debug-flag>`
+ The default pass is `linearize`.
+
+-v<debug-flag>
Add or display some debug info. The flag can be one of:
+
* `dead`: annotate dead pseudos.
* `entry`: dump the IR after all optimization passes.