Remove unused function parameter (NFC)
[oota-llvm.git] / tools / gold / README.txt
index 6427d09c77005ce34f781d96cf3a08c06a7f1deb..286d9af13b5485cfb80a693165a3a7842fb80d20 100644 (file)
@@ -1,17 +1,13 @@
+The LLVM Gold LTO Plugin
+========================
+
 This directory contains a plugin that is designed to work with binutils
 gold linker. At present time, this is not the default linker in
 binutils, and the default build of gold does not support plugins.
 
-Obtaining binutils:
-
-  cvs -z 9 -d :pserver:anoncvs@sourceware.org:/cvs/src login
-  {enter "anoncvs" as the password}
-  cvs -z 9 -d :pserver:anoncvs@sourceware.org:/cvs/src co binutils
-
-This will create a src/ directory. Make a build/ directory and from
-there configure binutils with "../src/configure --enable-gold --enable-plugins".
-Then build binutils with "make all-gold".
+See docs/GoldPlugin.html for complete build and usage instructions.
 
-To build the LLVMgold plugin, configure LLVM with the option
---with-binutils-include=/path/to/binutils/src/include/ . To use the
-plugin, run "ld-new --plugin /path/to/libLLVMgold.so".
+NOTE: libLTO and LLVMgold aren't built without PIC because they would fail
+to link on x86-64 with a relocation error: PIC and non-PIC can't be combined.
+As an alternative to passing --enable-pic, you can use 'make ENABLE_PIC=1' in
+your entire LLVM build.