diff options
Diffstat (limited to 'docs/CommandGuide')
| -rw-r--r-- | docs/CommandGuide/index.html | 24 | ||||
| -rw-r--r-- | docs/CommandGuide/llvm-extract.pod | 12 | ||||
| -rw-r--r-- | docs/CommandGuide/llvmc.pod | 190 | ||||
| -rw-r--r-- | docs/CommandGuide/llvmgcc.pod | 76 | ||||
| -rw-r--r-- | docs/CommandGuide/llvmgxx.pod | 85 |
5 files changed, 13 insertions, 374 deletions
diff --git a/docs/CommandGuide/index.html b/docs/CommandGuide/index.html index cb5438f..3e4e220 100644 --- a/docs/CommandGuide/index.html +++ b/docs/CommandGuide/index.html @@ -69,9 +69,6 @@ options) arguments to the tool you are interested in.</p> <li><a href="/cmds/llvm-config.html"><b>llvm-config</b></a> - print out LLVM compilation options, libraries, etc. as configured</li> -<li><a href="/cmds/llvmc.html"><b>llvmc</b></a> - - a generic customizable compiler driver</li> - <li><a href="/cmds/llvm-diff.html"><b>llvm-diff</b></a> - structurally compare two modules</li> @@ -81,25 +78,6 @@ options) arguments to the tool you are interested in.</p> <!-- *********************************************************************** --> <h2> - <a name="frontend">C and C++ Front-end Commands</a> -</h2> -<!-- *********************************************************************** --> - -<div> -<ul> - -<li><a href="/cmds/llvmgcc.html"><b>llvm-gcc</b></a> - - GCC-based C front-end for LLVM - -<li><a href="/cmds/llvmgxx.html"><b>llvm-g++</b></a> - - GCC-based C++ front-end for LLVM</li> - -</ul> - -</div> - -<!-- *********************************************************************** --> -<h2> <a name="debug">Debugging Tools</a> </h2> <!-- *********************************************************************** --> @@ -151,7 +129,7 @@ options) arguments to the tool you are interested in.</p> src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ + Last modified: $Date: 2011-09-20 20:24:04 +0200 (Tue, 20 Sep 2011) $ </address> </body> diff --git a/docs/CommandGuide/llvm-extract.pod b/docs/CommandGuide/llvm-extract.pod index 797e79d..67f00f0 100644 --- a/docs/CommandGuide/llvm-extract.pod +++ b/docs/CommandGuide/llvm-extract.pod @@ -37,11 +37,23 @@ B<llvm-extract> will write raw bitcode regardless of the output device. Extract the function named I<function-name> from the LLVM bitcode. May be specified multiple times to extract multiple functions at once. +=item B<--rfunc> I<function-regular-expr> + +Extract the function(s) matching I<function-regular-expr> from the LLVM bitcode. +All functions matching the regular expression will be extracted. May be +specified multiple times. + =item B<--glob> I<global-name> Extract the global variable named I<global-name> from the LLVM bitcode. May be specified multiple times to extract multiple global variables at once. +=item B<--rglob> I<glob-regular-expr> + +Extract the global variable(s) matching I<global-regular-expr> from the LLVM +bitcode. All global variables matching the regular expression will be extracted. +May be specified multiple times. + =item B<-help> Print a summary of command line options. diff --git a/docs/CommandGuide/llvmc.pod b/docs/CommandGuide/llvmc.pod deleted file mode 100644 index 95a9e5e..0000000 --- a/docs/CommandGuide/llvmc.pod +++ /dev/null @@ -1,190 +0,0 @@ -=pod - -=head1 NAME - -llvmc - The LLVM Compiler Driver (WIP) - -=head1 SYNOPSIS - -B<llvmc> [I<options>] I<filenames...> - -=head1 DESCRIPTION - -B<llvmc> is a configurable driver for invoking other LLVM (and non-LLVM) tools -in order to compile, optimize and link software for multiple languages. For -those familiar with FSF's B<gcc> tool, it is very similar. Please note that -B<llvmc> is considered an experimental tool. - -=head1 OPTIONS - -=head2 Built-in Options - -LLVMC has some built-in options that can't be overridden in the -configuration libraries. - -=over - -=item B<-o> I<filename> - -Output file name. - -=item B<-x> I<language> - -Specify the language of the following input files until the next B<-x> -option. - -=item B<-load> I<plugin_name> - -Load the specified plugin DLL. Example: -S<-load $LLVM_DIR/Release/lib/LLVMCSimple.so>. - -=item B<-v> or B<--verbose> - -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. 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 and exit. Requires that -you have I<dot> and I<gv> programs installed. Hidden option, useful for -debugging LLVMC plugins. - -=item B<--write-graph> - -Write a I<compilation-graph.dot> 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> - -Write temporary files to the current directory and do not delete them on -exit. This option can also take an argument: the I<--save-temps=obj> switch will -write files into the directory specified with the I<-o> option. The -I<--save-temps=cwd> and I<--save-temps> switches are both synonyms for the -default behaviour. - -=item B<--temp-dir> I<directory> - -Store temporary files in the given directory. This directory is deleted on exit -unless I<--save-temps> is specified. If I<--save-temps=obj> is also specified, -I<--temp-dir> is given the precedence. - -=item B<-help> - -Print a summary of command-line options and exit. - -=item B<-help-hidden> - -Print a summary of command-line options and exit. Print help even for -options intended for developers. - -=item B<--version> - -Print version information and exit. - -=item B<@>I<file> - -Read command-line options from I<file>. The options read are inserted -in place of the original @I<file> option. If I<file> does not exist, or -cannot be read, then the option will be treated literally, and not -removed. - -Options in I<file> are separated by whitespace. A whitespace character -may be included in an option by surrounding the entire option in -either single or double quotes. Any character (including a backslash) -may be included by prefixing the character to be included with a -backslash. The file may itself contain additional @I<file> options; -any such options will be processed recursively. - - -=back - - -=head2 Control Options - -By default, LLVMC is built with some standard configuration libraries -that define the following options: - -=over - -=item B<-clang> - -Use Clang instead of llvm-gcc. - -=item B<-opt> - -Enable optimization passes with B<opt>. To pass options to the B<opt> program -use the B<-Wo,> option. - -=item B<-I> I<directory> - -Add a directory to the header file search path. - -=item B<-L> I<directory> - -Add I<directory> to the library search path. - -=item B<-F> I<directory> - -Add I<directory> to the framework search path. - -=item B<-l>I<name> - -Link in the library libI<name>.[bc | a | so]. This library should -be a bitcode library. - -=item B<-framework> I<name> - -Link in the library libI<name>.[bc | a | so]. This library should -be a bitcode library. - -=item B<-emit-llvm> - -Output LLVM bitcode (with B<-c>) or assembly (with B<-S>) instead of native -object (or assembly). If B<-emit-llvm> is given without either B<-c> or B<-S> -it has no effect. - -=item B<-Wa> - -Pass options to assembler. - -=item B<-Wl> - -Pass options to linker. - -=item B<-Wo> - -Pass options to opt. - -=item B<-Wllc> - -Pass options to llc (code generator). - -=back - -=head1 EXIT STATUS - -If B<llvmc> succeeds, it will exit with code 0. Otherwise, if an -error occurs, it will exit with a non-zero value. If one of the -compilation tools returns a non-zero status, pending actions will be -discarded and B<llvmc> will return the same result code as the failing -compilation tool. - -=head1 SEE ALSO - -L<llvm-gcc|llvmgcc>, L<llvm-g++|llvmgxx>, L<llvm-as|llvm-as>, -L<llvm-dis|llvm-dis>, L<llc|llc>, L<llvm-link|llvm-link> - -=head1 AUTHORS - -Maintained by the LLVM Team (L<http://llvm.org/>). - -=cut diff --git a/docs/CommandGuide/llvmgcc.pod b/docs/CommandGuide/llvmgcc.pod deleted file mode 100644 index 30af0a06e..0000000 --- a/docs/CommandGuide/llvmgcc.pod +++ /dev/null @@ -1,76 +0,0 @@ -=pod - -=head1 NAME - -llvm-gcc - LLVM C front-end - -=head1 SYNOPSIS - -B<llvm-gcc> [I<options>] I<filename> - -=head1 DESCRIPTION - -The B<llvm-gcc> command is the LLVM C front end. It is a modified -version of gcc that compiles C/ObjC programs into native objects, LLVM -bitcode or LLVM assembly language, depending upon the options. - -By default, B<llvm-gcc> compiles to native objects just like GCC does. If the -B<-emit-llvm> and B<-c> options are given then it will generate LLVM bitcode files -instead. If B<-emit-llvm> and B<-S> are given, then it will generate LLVM -assembly. - -Being derived from the GNU Compiler Collection, B<llvm-gcc> has many -of gcc's features and accepts most of gcc's options. It handles a -number of gcc's extensions to the C programming language. See the gcc -documentation for details. - -=head1 OPTIONS - -=over - -=item B<--help> - -Print a summary of command line options. - -=item B<-o> I<filename> - -Specify the output file to be I<filename>. - -=item B<-I> I<directory> - -Add a directory to the header file search path. This option can be -repeated. - -=item B<-L> I<directory> - -Add I<directory> to the library search path. This option can be -repeated. - -=item B<-l>I<name> - -Link in the library libI<name>.[bc | a | so]. This library should -be a bitcode library. - -=item B<-emit-llvm> - -Make the output be LLVM bitcode (with B<-c>) or assembly (with B<-s>) instead -of native object (or assembly). If B<-emit-llvm> is given without either B<-c> -or B<-S> it has no effect. - -=back - -=head1 EXIT STATUS - -If B<llvm-gcc> succeeds, it will exit with 0. Otherwise, if an error -occurs, it will exit with a non-zero value. - -=head1 SEE ALSO - -L<llvm-g++|llvmgxx> - -=head1 AUTHORS - -Maintained by the LLVM Team (L<http://llvm.org/>). - -=cut - diff --git a/docs/CommandGuide/llvmgxx.pod b/docs/CommandGuide/llvmgxx.pod deleted file mode 100644 index 1ea3d49..0000000 --- a/docs/CommandGuide/llvmgxx.pod +++ /dev/null @@ -1,85 +0,0 @@ -=pod - -=head1 NAME - -llvm-g++ - LLVM C++ front-end - -=head1 SYNOPSIS - -B<llvm-g++> [I<options>] I<filename> - -=head1 DESCRIPTION - -The B<llvm-g++> command is the LLVM C++ front end. It is a modified -version of g++ that compiles C++/ObjC++ programs into native code, -LLVM bitcode or assembly language, depending upon the options. - -By default, B<llvm-g++> compiles to native objects just like GCC does. If the -B<-emit-llvm> option is given then it will generate LLVM bitcode files instead. -If B<-S> (assembly) is also given, then it will generate LLVM assembly. - -Being derived from the GNU Compiler Collection, B<llvm-g++> has many -of g++'s features and accepts most of g++'s options. It handles a -number of g++'s extensions to the C++ programming language. - -=head1 OPTIONS - -=over - -=item B<--help> - -Print a summary of command line options. - -=item B<-S> - -Do not generate an LLVM bitcode file. Rather, compile the source -file into an LLVM assembly language file. - -=item B<-c> - -Do not generate a linked executable. Rather, compile the source -file into an LLVM bitcode file. This bitcode file can then be -linked with other bitcode files later on to generate a full LLVM -executable. - -=item B<-o> I<filename> - -Specify the output file to be I<filename>. - -=item B<-I> I<directory> - -Add a directory to the header file search path. This option can be -repeated. - -=item B<-L> I<directory> - -Add I<directory> to the library search path. This option can be -repeated. - -=item B<-l>I<name> - -Link in the library libI<name>.[bc | a | so]. This library should -be a bitcode library. - -=item B<-emit-llvm> - -Make the output be LLVM bitcode (or assembly) instead of native object (or -assembly). - -=back - -=head1 EXIT STATUS - -If B<llvm-g++> succeeds, it will exit with 0. Otherwise, if an error -occurs, it will exit with a non-zero value. - -=head1 SEE ALSO - -L<llvm-gcc|llvmgcc> - -=head1 AUTHORS - -Maintained by the LLVM Team (L<http://llvm.org/>). - -=cut - |
