X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FGoldPlugin.rst;h=17bbeb8ba9f85d4bafa35e6f351568d10b548f78;hb=fc699872e35ec794d7373680be6f1946fe8e9ca6;hp=8e4713e433437800f743b36a53e3591cd97658a1;hpb=34c6b7e925566cfa71e3087f70c6e4453f51cd25;p=oota-llvm.git diff --git a/docs/GoldPlugin.rst b/docs/GoldPlugin.rst index 8e4713e4334..17bbeb8ba9f 100644 --- a/docs/GoldPlugin.rst +++ b/docs/GoldPlugin.rst @@ -1,11 +1,7 @@ -.. _gold-plugin: - ==================== The LLVM gold plugin ==================== -.. sectionauthor:: Nick Lewycky - Introduction ============ @@ -76,11 +72,11 @@ You can produce bitcode files from ``clang`` using ``-emit-llvm`` or Any of these flags will also cause ``clang`` to look for the gold plugin in the ``lib`` directory under its prefix and pass the ``-plugin`` option to ``ld``. It will not look for an alternate linker, which is why you need -gold to be the installed system linker in your path.`` +gold to be the installed system linker in your path. If you want ``ar`` and ``nm`` to work seamlessly as well, install ``LLVMgold.so`` to ``/usr/lib/bfd-plugins``. If you built your own gold, be -sure to install the ``ar`` and ``nm-new`` you built to ``/usr/bin`` +sure to install the ``ar`` and ``nm-new`` you built to ``/usr/bin``. Example of link time optimization @@ -181,6 +177,6 @@ Licensing ========= Gold is licensed under the GPLv3. LLVMgold uses the interface file -``plugin-api.h`` from gold which means that the resulting LLVMgold.so +``plugin-api.h`` from gold which means that the resulting ``LLVMgold.so`` binary is also GPLv3. This can still be used to link non-GPLv3 programs just as much as gold could without the plugin.