The file dev-options.md contains the description for extra
options not useful for sparse itself and its users but well
to sparse's developers and for tools like test-linearize.
Since it's a complement to the main man-page, format it at such.
Signed-off-by: Luc Van Oostenryck <luc.vanoostenryck@xxxxxxxxx>
---
Documentation/.gitignore | 1 +
Documentation/Makefile | 4 ++++
Documentation/conf.py | 1 +
Documentation/dev-options.md | 24 ++++++++++++++++--------
4 files changed, 22 insertions(+), 8 deletions(-)
diff --git a/Documentation/.gitignore b/Documentation/.gitignore
index 378eac25d..6c08d03c8 100644
--- a/Documentation/.gitignore
+++ b/Documentation/.gitignore
@@ -1 +1,2 @@
build
+dev-options.1
diff --git a/Documentation/Makefile b/Documentation/Makefile
index 8bb5b9e49..64dc0f66b 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -10,6 +10,7 @@ BUILDDIR = build
targets := help
targets += html
+targets += man
# Put it first so that "make" without argument is like "make help".
@@ -19,4 +20,7 @@ help:
$(targets): conf.py Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
+%.1: %.md man
+ @mv build/man/$@ $@
+
.PHONY: Makefile # avoid circular deps with the catch-all rule
diff --git a/Documentation/conf.py b/Documentation/conf.py
index abd496db1..24f0f89ab 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -154,6 +154,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
+ ('dev-options', 'dev-options', u'options for development', [author], 1),
]
diff --git a/Documentation/dev-options.md b/Documentation/dev-options.md
index d4aa6aff6..8b1b30bcf 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.
--
2.17.0
--
To unsubscribe from this list: send the line "unsubscribe linux-sparse" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
