diff options
author | Rui Ueyama <ruiu@google.com> | 2016-03-12 06:06:40 +0000 |
---|---|---|
committer | Rui Ueyama <ruiu@google.com> | 2016-03-12 06:06:40 +0000 |
commit | 02aa766897f5b0ce406076db34934acf0012bd7f (patch) | |
tree | 27e34b825cbe492e8f3112eb2ae998c925b9a8a2 /lld/docs/index.rst | |
parent | 8fc20ade65e2eea2fbe5b184b6f0c3fb82a41aab (diff) | |
download | bcm5719-llvm-02aa766897f5b0ce406076db34934acf0012bd7f.tar.gz bcm5719-llvm-02aa766897f5b0ce406076db34934acf0012bd7f.zip |
Update the documents of the new LLD.
This patch merges the documents for ELF and COFF into one
and puts it into docs directory.
llvm-svn: 263336
Diffstat (limited to 'lld/docs/index.rst')
-rw-r--r-- | lld/docs/index.rst | 73 |
1 files changed, 4 insertions, 69 deletions
diff --git a/lld/docs/index.rst b/lld/docs/index.rst index f109610e4d3..d019c4f9fd8 100644 --- a/lld/docs/index.rst +++ b/lld/docs/index.rst @@ -4,55 +4,12 @@ lld - The LLVM Linker ===================== lld contains two linkers whose architectures are different from each other. -One is a linker that implements native features directly. -They are in `COFF` or `ELF` directories. Other directories contains the other -implementation that is designed to be a set of modular code for creating -linker tools. This document covers mainly the latter. -For the former, please read README.md in `COFF` directory. -* End-User Features: - - * Compatible with existing linker options - * Reads standard Object Files (e.g. ELF, Mach-O, PE/COFF) - * Writes standard Executable Files (e.g. ELF, Mach-O, PE) - * Remove clang's reliance on "the system linker" - * Uses the LLVM `"UIUC" BSD-Style license`__. - -* Applications: - - * Modular design - * Support cross linking - * Easy to add new CPU support - * Can be built as static tool or library - -* Design and Implementation: - - * Extensive unit tests - * Internal linker model can be dumped/read to textual format - * Additional linking features can be plugged in as "passes" - * OS specific and CPU specific code factored out - -Why a new linker? ------------------ - -The fact that clang relies on whatever linker tool you happen to have installed -means that clang has been very conservative adopting features which require a -recent linker. - -In the same way that the MC layer of LLVM has removed clang's reliance on the -system assembler tool, the lld project will remove clang's reliance on the -system linker tool. - - -Current Status --------------- - -lld can self host on x86-64 FreeBSD and Linux and x86 Windows. - -All SingleSource tests in test-suite pass on x86-64 Linux. +.. toctree:: + :maxdepth: 1 -All SingleSource and MultiSource tests in the LLVM test-suite -pass on MIPS 32-bit little-endian Linux. + NewLLD + AtomLLD Source ------ @@ -66,25 +23,3 @@ lld is also available via the read-only git mirror:: git clone http://llvm.org/git/lld.git Put it in llvm's tools/ directory, rerun cmake, then build target lld. - -Contents --------- - -.. toctree:: - :maxdepth: 2 - - design - getting_started - ReleaseNotes - development - windows_support - open_projects - sphinx_intro - -Indices and tables ------------------- - -* :ref:`genindex` -* :ref:`search` - -__ http://llvm.org/docs/DeveloperPolicy.html#license |