diff options
author | Daniel Dunbar <daniel@zuster.org> | 2009-09-15 20:31:28 +0000 |
---|---|---|
committer | Daniel Dunbar <daniel@zuster.org> | 2009-09-15 20:31:28 +0000 |
commit | 6db36f3ce9df64d3ce29c42b1b365338965cd89d (patch) | |
tree | 60c01d72d860708358448741b6dfc16d7b39e450 /docs/CommandGuide | |
parent | 504f9a61e61ee274fe50d8300825bdc2e5adb9b0 (diff) | |
download | external_llvm-6db36f3ce9df64d3ce29c42b1b365338965cd89d.zip external_llvm-6db36f3ce9df64d3ce29c42b1b365338965cd89d.tar.gz external_llvm-6db36f3ce9df64d3ce29c42b1b365338965cd89d.tar.bz2 |
Update llc/opt PODs to clarify they support .ll input.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@81910 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/CommandGuide')
-rw-r--r-- | docs/CommandGuide/llc.pod | 17 | ||||
-rw-r--r-- | docs/CommandGuide/opt.pod | 19 |
2 files changed, 19 insertions, 17 deletions
diff --git a/docs/CommandGuide/llc.pod b/docs/CommandGuide/llc.pod index 7a7bbca..fd38abd 100644 --- a/docs/CommandGuide/llc.pod +++ b/docs/CommandGuide/llc.pod @@ -10,18 +10,19 @@ B<llc> [I<options>] [I<filename>] =head1 DESCRIPTION -The B<llc> command compiles LLVM bitcode into assembly language for a +The B<llc> command compiles LLVM source inputs into assembly language for a specified architecture. The assembly language output can then be passed through a native assembler and linker to generate a native executable. The choice of architecture for the output assembly code is automatically -determined from the input bitcode file, unless the B<-march> option is used to -override the default. +determined from the input file, unless the B<-march> option is used to override +the default. =head1 OPTIONS -If I<filename> is - or omitted, B<llc> reads LLVM bitcode from standard input. -Otherwise, it will read LLVM bitcode from I<filename>. +If I<filename> is - or omitted, B<llc> reads from standard input. Otherwise, it +will from I<filename>. Inputs can be in either the LLVM assembly language +format (.ll) or the LLVM bitcode format (.bc). If the B<-o> option is omitted, then B<llc> will send its output to standard output if the input is from standard input. If the B<-o> option specifies -, @@ -55,13 +56,13 @@ B<llvm-extract> will write raw bitcode regardless of the output device. =item B<-mtriple>=I<target triple> -Override the target triple specified in the input bitcode file with the -specified string. +Override the target triple specified in the input file with the specified +string. =item B<-march>=I<arch> Specify the architecture for which to generate assembly, overriding the target -encoded in the bitcode file. See the output of B<llc --help> for a list of +encoded in the input file. See the output of B<llc --help> for a list of valid architectures. By default this is inferred from the target triple or autodetected to the current architecture. diff --git a/docs/CommandGuide/opt.pod b/docs/CommandGuide/opt.pod index a6c18b1..d1d1db5 100644 --- a/docs/CommandGuide/opt.pod +++ b/docs/CommandGuide/opt.pod @@ -11,24 +11,25 @@ B<opt> [I<options>] [I<filename>] =head1 DESCRIPTION The B<opt> command is the modular LLVM optimizer and analyzer. It takes LLVM -bitcode as input, runs the specified optimizations or analyses on it, and then -outputs the optimized LLVM bitcode or the analysis results. The function of +source files as input, runs the specified optimizations or analyses on it, and then +outputs the optimized file or the analysis results. The function of B<opt> depends on whether the B<-analyze> option is given. -When B<-analyze> is specified, B<opt> performs various analyses of LLVM -bitcode. It will usually print the results on standard output, but in a few -cases, it will print output to standard error or generate a file with the -analysis output, which is usually done when the output is meant for another -program. +When B<-analyze> is specified, B<opt> performs various analyses of the input +source. It will usually print the results on standard output, but in a few +cases, it will print output to standard error or generate a file with the +analysis output, which is usually done when the output is meant for another +program. While B<-analyze> is I<not> given, B<opt> attempts to produce an optimized -bitcode file. The optimizations available via B<opt> depend upon what +output file. The optimizations available via B<opt> depend upon what libraries were linked into it as well as any additional libraries that have been loaded with the B<-load> option. Use the B<-help> option to determine what optimizations you can use. If I<filename> is omitted from the command line or is I<->, B<opt> reads its -input from standard input. The input must be an LLVM bitcode file. +input from standard input. Inputs can be in either the LLVM assembly language +format (.ll) or the LLVM bitcode format (.bc). If an output filename is not specified with the B<-o> option, B<opt> writes its output to the standard output. |