From c44f8d00d04633605cb1a1aa61a949e96f8022aa Mon Sep 17 00:00:00 2001 From: Luc Van Oostenryck Date: Sun, 18 Mar 2018 13:19:05 +0100 Subject: doc: options.md is for development The purpose of the file 'options.md' was rather vague. Make it now explicit that it's to document options useful for development. Reviewed-by: Randy Dunlap Signed-off-by: Luc Van Oostenryck --- Documentation/dev-options.md | 28 ++++++++++++++++++++++++++++ Documentation/options.md | 29 ----------------------------- 2 files changed, 28 insertions(+), 29 deletions(-) create mode 100644 Documentation/dev-options.md delete mode 100644 Documentation/options.md (limited to 'Documentation') diff --git a/Documentation/dev-options.md b/Documentation/dev-options.md new file mode 100644 index 00000000..23ea2133 --- /dev/null +++ b/Documentation/dev-options.md @@ -0,0 +1,28 @@ +# Options + +This file is a complement of sparse's man page meant to +document options only useful for development on sparse itself. + +## Developer options: + +### Select the passes + +* '-f\[-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 + +* '-fdump-ir[=\[,\...]]' + + Dump the IR at each of the given passes. + + The passes currently understood are: + * 'linearize' + * 'mem2reg' + * 'final' diff --git a/Documentation/options.md b/Documentation/options.md deleted file mode 100644 index 14698a98..00000000 --- a/Documentation/options.md +++ /dev/null @@ -1,29 +0,0 @@ -# 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\[-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[=\[,\...]]' - - Dump the IR at each of the given passes. - - The passes currently understood are: - * 'linearize' - * 'mem2reg' - * 'final' -- cgit 1.2.3-korg