From 0f78c2721b03d06b08c5ba8aaa49f880e4473125 Mon Sep 17 00:00:00 2001 From: Mikhail Glushenkov Date: Fri, 27 Mar 2009 12:58:29 +0000 Subject: [PATCH] Documentation update. Expand a bit on various '--*-graph' options. llvm-svn: 67836 --- llvm/docs/CommandGuide/llvmc.pod | 24 +++++++++++++---------- llvm/docs/CompilerDriver.html | 25 +++++++++++++----------- llvm/tools/llvmc/doc/LLVMC-Reference.rst | 23 ++++++++++++---------- 3 files changed, 41 insertions(+), 31 deletions(-) diff --git a/llvm/docs/CommandGuide/llvmc.pod b/llvm/docs/CommandGuide/llvmc.pod index 53eecaf05251..18ffb9f03a57 100644 --- a/llvm/docs/CommandGuide/llvmc.pod +++ b/llvm/docs/CommandGuide/llvmc.pod @@ -44,21 +44,24 @@ Enable verbose mode, i.e. print out all executed commands. =item B<--check-graph> -Check the compilation for common errors like mismatched output/input -language names, multiple default edges and cycles. Hidden option, -useful for debugging. +Check the compilation for common errors like mismatched output/input language +names, multiple default edges and cycles. Because of plugins, these checks can't +be performed at compile-time. Exit with code zero if no errors were found, and +return the number of found errors otherwise. Hidden option, useful for debugging +LLVMC plugins. =item B<--view-graph> -Show a graphical representation of the compilation graph. Requires -that you have I and I programs installed. Hidden option, -useful for debugging. +Show a graphical representation of the compilation graph and exit. Requires that +you have I and I programs installed. Hidden option, useful for +debugging LLVMC plugins. =item B<--write-graph> -Write a I file in the current directory with -the compilation graph description in the Graphviz format. Hidden -option, useful for debugging. +Write a I file in the current directory with the +compilation graph description in Graphviz format (identical to the file used by +the B<--view-graph> option). The B<-o> option can be used to set the output file +name. Hidden option, useful for debugging LLVMC plugins. =item B<--save-temps> @@ -109,7 +112,8 @@ Use Clang instead of llvm-gcc. =item B<-opt> -Enable optimization with B. +Enable optimization passes with B. To pass options to the B program +use the B<-Wo,> option. =item B<-I> I diff --git a/llvm/docs/CompilerDriver.html b/llvm/docs/CompilerDriver.html index 6338dd247696..f5767b833876 100644 --- a/llvm/docs/CompilerDriver.html +++ b/llvm/docs/CompilerDriver.html @@ -107,15 +107,18 @@ until the next -x option.
  • -load PLUGIN_NAME - Load the specified plugin DLL. Example: -load $LLVM_DIR/Release/lib/LLVMCSimple.so.
  • -v - Enable verbose mode, i.e. print out all executed commands.
    • -
  • --check-graph - Check the compilation for common errors like -mismatched output/input language names, multiple default edges and -cycles. Hidden option, useful for debugging.
    • -
  • --view-graph - Show a graphical representation of the compilation -graph. Requires that you have dot and gv programs -installed. Hidden option, useful for debugging.
    • -
  • --write-graph - Write a compilation-graph.dot file in the -current directory with the compilation graph description in the -Graphviz format. Hidden option, useful for debugging.
    • +
  • --check-graph - Check the compilation for common errors like mismatched +output/input language names, multiple default edges and cycles. Because of +plugins, these checks can't be performed at compile-time. Exit with code zero if +no errors were found, and return the number of found errors otherwise. Hidden +option, useful for debugging LLVMC plugins.
    • +
  • --view-graph - Show a graphical representation of the compilation graph +and exit. Requires that you have dot and gv programs installed. Hidden +option, useful for debugging LLVMC plugins.
    • +
  • --write-graph - Write a compilation-graph.dot file in the current +directory with the compilation graph description in Graphviz format (identical +to the file used by the --view-graph option). The -o option can be used +to set the output file name. Hidden option, useful for debugging LLVMC plugins.
  • --save-temps - Write temporary files to the current directory and do not delete them on exit. Hidden option, useful for debugging.
  • --help, --help-hidden, --version - These options have @@ -589,7 +592,7 @@ loaded last.

    When writing LLVMC plugins, it can be useful to get a visual view of the resulting compilation graph. This can be achieved via the command line option --view-graph. This command assumes that Graphviz and -Ghostview are installed. There is also a --dump-graph option that +Ghostview are installed. There is also a --write-graph option that creates a Graphviz source file (compilation-graph.dot) in the current directory.

    Another useful llvmc option is --check-graph. It checks the @@ -611,7 +614,7 @@ errors as its status code.

    Mikhail Glushenkov
    LLVM Compiler Infrastructure
    -Last modified: $Date$ +Last modified: $Date: 2008-12-11 11:34:48 -0600 (Thu, 11 Dec 2008) $ diff --git a/llvm/tools/llvmc/doc/LLVMC-Reference.rst b/llvm/tools/llvmc/doc/LLVMC-Reference.rst index 9aca609ca1de..f6d1843faaf5 100644 --- a/llvm/tools/llvmc/doc/LLVMC-Reference.rst +++ b/llvm/tools/llvmc/doc/LLVMC-Reference.rst @@ -92,17 +92,20 @@ configuration libraries: * ``-v`` - Enable verbose mode, i.e. print out all executed commands. -* ``--check-graph`` - Check the compilation for common errors like - mismatched output/input language names, multiple default edges and - cycles. Hidden option, useful for debugging. +* ``--check-graph`` - Check the compilation for common errors like mismatched + output/input language names, multiple default edges and cycles. Because of + plugins, these checks can't be performed at compile-time. Exit with code zero if + no errors were found, and return the number of found errors otherwise. Hidden + option, useful for debugging LLVMC plugins. -* ``--view-graph`` - Show a graphical representation of the compilation - graph. Requires that you have ``dot`` and ``gv`` programs - installed. Hidden option, useful for debugging. +* ``--view-graph`` - Show a graphical representation of the compilation graph + and exit. Requires that you have ``dot`` and ``gv`` programs installed. Hidden + option, useful for debugging LLVMC plugins. -* ``--write-graph`` - Write a ``compilation-graph.dot`` file in the - current directory with the compilation graph description in the - Graphviz format. Hidden option, useful for debugging. +* ``--write-graph`` - Write a ``compilation-graph.dot`` file in the current + directory with the compilation graph description in Graphviz format (identical + to the file used by the ``--view-graph`` option). The ``-o`` option can be used + to set the output file name. Hidden option, useful for debugging LLVMC plugins. * ``--save-temps`` - Write temporary files to the current directory and do not delete them on exit. Hidden option, useful for debugging. @@ -631,7 +634,7 @@ Debugging When writing LLVMC plugins, it can be useful to get a visual view of the resulting compilation graph. This can be achieved via the command line option ``--view-graph``. This command assumes that Graphviz_ and -Ghostview_ are installed. There is also a ``--dump-graph`` option that +Ghostview_ are installed. There is also a ``--write-graph`` option that creates a Graphviz source file (``compilation-graph.dot``) in the current directory.