summaryrefslogtreecommitdiff
path: root/tools/gold/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'tools/gold/README.txt')
-rw-r--r--tools/gold/README.txt20
1 files changed, 6 insertions, 14 deletions
diff --git a/tools/gold/README.txt b/tools/gold/README.txt
index a906a9083e..286d9af13b 100644
--- a/tools/gold/README.txt
+++ b/tools/gold/README.txt
@@ -1,21 +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/ --enable-pic. To use the
-plugin, run "ld-new --plugin /path/to/LLVMgold.so".
-Without PIC libLTO and LLVMgold are not being built (because they would fail
-link on x86-64 with a relocation error: PIC and non-PIC can't be combined).
+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.