diff options
| author | Luc Van Oostenryck <luc.vanoostenryck@gmail.com> | 2018-02-24 11:40:45 +0100 |
|---|---|---|
| committer | Luc Van Oostenryck <luc.vanoostenryck@gmail.com> | 2018-05-21 02:49:43 +0200 |
| commit | d22015775e0b76ccf64ad1f8afc68443c308fbce (patch) | |
| tree | 219d7b150bcd4b622d7c2afc8b3cf46e39ee74cc /Documentation | |
| parent | b048f49bd28074bcbdc7506f1a61b48c842633ed (diff) | |
| download | sparse-dev-d22015775e0b76ccf64ad1f8afc68443c308fbce.tar.gz | |
doc: format dev-options.md as a man page
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@gmail.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/.gitignore | 1 | ||||
| -rw-r--r-- | Documentation/Makefile | 4 | ||||
| -rw-r--r-- | Documentation/conf.py | 1 | ||||
| -rw-r--r-- | Documentation/dev-options.md | 24 |
4 files changed, 22 insertions, 8 deletions
diff --git a/Documentation/.gitignore b/Documentation/.gitignore index 378eac25..6c08d03c 100644 --- a/Documentation/.gitignore +++ b/Documentation/.gitignore @@ -1 +1,2 @@ build +dev-options.1 diff --git a/Documentation/Makefile b/Documentation/Makefile index 8bb5b9e4..64dc0f66 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 abd496db..24f0f89a 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 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. |