]> granicus.if.org Git - llvm/commitdiff
Revert "[docs] As of binutils 2.21.51.0.2, ld.bfd supports plugins too, represent...
authorTeresa Johnson <tejohnson@google.com>
Wed, 11 Jul 2018 20:08:32 +0000 (20:08 +0000)
committerTeresa Johnson <tejohnson@google.com>
Wed, 11 Jul 2018 20:08:32 +0000 (20:08 +0000)
This reverts commit r306102.

This change was made without any review, and has a couple of issues.
First, AFAIK we do not test the combination of the LLVM gold plugin with
ld.bfd. Second, the change removed documentation for how to build gold
and replaced it with instructions for building ld.bfd.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@336841 91177308-0d34-0410-b5e6-96231b3b80d8

docs/GoldPlugin.rst

index 78d38ccb32bd18d950b21d8a76b7c22e001841fb..88b944a2a0fdd47e403b4a9f99a48d7065b915c0 100644 (file)
@@ -7,7 +7,7 @@ Introduction
 
 Building with link time optimization requires cooperation from
 the system linker. LTO support on Linux systems requires that you use the
-`gold linker`_ or ld.bfd from binutils >= 2.21.51.0.2, as they support LTO via plugins. This is the same mechanism
+`gold linker`_ which supports LTO via plugins. This is the same mechanism
 used by the `GCC LTO`_ project.
 
 The LLVM gold plugin implements the gold plugin interface on top of
@@ -23,22 +23,24 @@ The LLVM gold plugin implements the gold plugin interface on top of
 How to build it
 ===============
 
-Check for plugin support by running ``/usr/bin/ld -plugin``. If it complains
-"missing argument" then you have plugin support. If not, such as an "unknown option"
-error then you will either need to build gold or install a recent version
-of ld.bfd with plugin support and then build gold plugin.
+You need to have gold with plugin support and build the LLVMgold plugin.
+Check whether you have gold running ``/usr/bin/ld -v``. It will report "GNU
+gold" or else "GNU ld" if not. If you have gold, check for plugin support
+by running ``/usr/bin/ld -plugin``. If it complains "missing argument" then
+you have plugin support. If not, such as an "unknown option" error then you
+will either need to build gold or install a version with plugin support.
 
-* Download, configure and build ld.bfd with plugin support:
+* Download, configure and build gold with plugin support:
 
   .. code-block:: bash
 
      $ git clone --depth 1 git://sourceware.org/git/binutils-gdb.git binutils
      $ mkdir build
      $ cd build
-     $ ../binutils/configure --disable-werror # ld.bfd includes plugin support by default
-     $ make all-ld
+     $ ../binutils/configure --enable-gold --enable-plugins --disable-werror
+     $ make all-gold
 
-  That should leave you with ``build/ld/ld-new`` which supports
+  That should leave you with ``build/gold/ld-new`` which supports
   the ``-plugin`` option. Running ``make`` will additionally build
   ``build/binutils/ar`` and ``nm-new`` binaries supporting plugins.