Commit 1296dfe8 authored by Bill Wendling's avatar Bill Wendling
Browse files

Merging r196100: 

------------------------------------------------------------------------
r196100 | alp | 2013-12-02 06:17:47 -0800 (Mon, 02 Dec 2013) | 4 lines

Cut the gold plugin README down to size

This file hasn't been updated in years. Remove old information and point to
the current documentation at GoldPlugin.rst.
------------------------------------------------------------------------

llvm-svn: 196135
parent 207f862f

llvm/tools/gold/README.txt

+6 −14
Original line number Diff line number Diff line 
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.