X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FCommandGuide%2Fllvm-ld.pod;h=d655737674ec3692189c90b768541e03c449b13e;hb=befc9c16fae1719cafe9f54ab2b67219db44dc11;hp=5f2e065231cdfcaa68e42b955c53f0923b4a6b51;hpb=4d9e7fe1f05d8c82286b18bc84c055f4f552ed4e;p=oota-llvm.git diff --git a/docs/CommandGuide/llvm-ld.pod b/docs/CommandGuide/llvm-ld.pod index 5f2e065231c..d655737674e 100644 --- a/docs/CommandGuide/llvm-ld.pod +++ b/docs/CommandGuide/llvm-ld.pod @@ -10,16 +10,16 @@ B =head1 DESCRIPTION -The B tool takes a set of LLVM bytecode files and links them -together into a single LLVM bytecode file. The output bytecode file can be -another bytecode file or an executable bytecode program. Using additional +The B tool takes a set of LLVM bitcode files and links them +together into a single LLVM bitcode file. The output bitcode file can be +another bitcode file or an executable bitcode program. Using additional options, B is able to produce native code executables. The B tool is the main linker for LLVM. It is used to link together the output of LLVM front-end compilers and run "link time" optimizations (mostly the inter-procedural kind). -The B tools attemps to mimic the interface provided by the default +The B tools attempts to mimic the interface provided by the default system linker so that it can act as a I replacement. =head2 Search Order @@ -47,13 +47,13 @@ and is applied to all libraries, preceding or succeeding, in the command line. =head2 Link order -All object and bytecode files are linked first in the order they were +All object and bitcode files are linked first in the order they were specified on the command line. All library files are linked next. Some libraries may not be linked into the object program; see below. =head2 Library Linkage -Object files and static bytecode objects are always linked into the output +Object files and static bitcode objects are always linked into the output file. Library archives (.a files) load only the objects within the archive that define symbols needed by the output file. Hence, libraries should be listed after the object files and libraries which need them; otherwise, the @@ -64,7 +64,7 @@ undefined symbols defined. The B program has limited support for native code generation, when using the B<-native> or B<-native-cbe> options. Native code generation is -perfomed by converting the linked bytecode into native assembly (.s) or C code +performed by converting the linked bitcode into native assembly (.s) or C code and running the system compiler (typically gcc) on the result. =head1 OPTIONS @@ -121,7 +121,7 @@ will not search the paths given by the B<-L> options following it. =item B<-link-as-library> -Link the bytecode files together as a library, not an executable. In this mode, +Link the bitcode files together as a library, not an executable. In this mode, undefined symbols will be permitted. =item B<-r> @@ -136,14 +136,14 @@ Specifies the kind of machine for which code or assembly should be generated. Generate a native machine code executable. -When generating native executables, B first checks for a bytecode +When generating native executables, B first checks for a bitcode version of the library and links it in, if necessary. If the library is missing, B skips it. Then, B links in the same libraries as native code. -In this way, B should be able to link in optimized bytecode +In this way, B should be able to link in optimized bitcode subsets of common libraries and then link in any part of the library that -hasn't been converted to bytecode. +hasn't been converted to bitcode. =item B<-native-cbe> @@ -153,10 +153,6 @@ This option is identical to the B<-native> option, but uses the C backend to generate code for the program instead of an LLVM native code generator. -=item B<-disable-compression> - -Do not compress bytecode files. - =back =head2 Optimization Options @@ -240,7 +236,7 @@ run. This feature allows the optimization passes of B to be extended. =item B<-post-link-opt>F -Run post-link optimization program. After linking is completed a bytecode file +Run post-link optimization program. After linking is completed a bitcode file will be generated. It will be passed to the program specified by F as the first argument. The second argument to the program will be the name of a temporary file into which the program should place its optimized output. For @@ -258,7 +254,7 @@ it will exit with a non-zero return code. =head1 ENVIRONMENT -The C environment variable is used to find bytecode +The C environment variable is used to find bitcode libraries. Any paths specified in this variable will be searched after the C<-L> options.