Commit Graph

40 Commits

Author SHA1 Message Date
Sylvestre Ledru 72fd1033ea Doc: Links should use https 2020-03-22 22:49:33 +01:00
Peter Smith 6d5603e2d2 [LLD][ELF] Add initial LLD LinkerScript docs page
LLD implements Linker Scripts as they are described in the GNU ld manual.
This description is far from a specification, with the only true reference
the GNU ld implementation, which has undocumented behaviour that can vary
from release to release.

To make it easy for people to switch between linkers we try to follow GNU
ld implementation details wherever possible. We reserve the right to make
our own decisions where the undocumented GNU ld behaviour is not
appropriate for LLD. We don't have a place to document these decisions and
it can be difficult for users to find out this information.

This file is a statement of the LLD implementation policy and will contain
intentional deviations from GNU ld.

The first patch that will add concrete details to this file is D75724

Differential Revision: https://reviews.llvm.org/D75921
2020-03-11 10:56:12 +00:00
Nico Weber bad8f3957e hopefully last doc typo fix to cycle bots 2019-12-20 22:28:21 -05:00
Peter Collingbourne 31fda09b2d Add IR support, ELF section and user documentation for partitioning feature.
The partitioning feature was proposed here:
http://lists.llvm.org/pipermail/llvm-dev/2019-February/130583.html

This is mostly just documentation. The feature itself will be contributed
in subsequent patches.

Differential Revision: https://reviews.llvm.org/D60242

llvm-svn: 361923
2019-05-29 03:29:01 +00:00
Hans Wennborg ccebc7e38c docs: add missingkeyfunction to doctree, fix title
llvm-svn: 353399
2019-02-07 12:39:35 +00:00
James Y Knight 5d71fc5d7b Adjust documentation for git migration.
This fixes most references to the paths:
 llvm.org/svn/
 llvm.org/git/
 llvm.org/viewvc/
 github.com/llvm-mirror/
 github.com/llvm-project/
 reviews.llvm.org/diffusion/

to instead point to https://github.com/llvm/llvm-project.

This is *not* a trivial substitution, because additionally, all the
checkout instructions had to be migrated to instruct users on how to
use the monorepo layout, setting LLVM_ENABLE_PROJECTS instead of
checking out various projects into various subdirectories.

I've attempted to not change any scripts here, only documentation. The
scripts will have to be addressed separately.

Additionally, I've deleted one document which appeared to be outdated
and unneeded:
  lldb/docs/building-with-debug-llvm.txt

Differential Revision: https://reviews.llvm.org/D57330

llvm-svn: 352514
2019-01-29 16:37:27 +00:00
Nico Weber 6a5d94cc08 lld/include/lld/Core/TODO.txt
- fix minor grammar stuff (I'm not a native speaker either, but it's hopefully a net improvement)
- mention that lld/coff is used in production
- update AArch64, ARM to production quality
- remove lld/include/lld/Core/TODO.txt which looks outdated

Differential Revision: https://reviews.llvm.org/D56600

llvm-svn: 351030
2019-01-14 00:45:27 +00:00
Hans Wennborg c7792a6cc7 index.rst: pe/coff does support pdbs now
llvm-svn: 338362
2018-07-31 12:00:26 +00:00
Sam Clegg c94d393ad5 [WebAssembly] Initial wasm linker implementation
This linker backend is still a work in progress but is
enough to link simple programs including linking against
library archives.

Differential Revision: https://reviews.llvm.org/D34851

llvm-svn: 318539
2017-11-17 18:14:09 +00:00
Rui Ueyama 0b9fbf97f0 Fix .rst formatting error.
llvm-svn: 314618
2017-10-01 03:50:48 +00:00
Rui Ueyama 7430897a1d Update benchmark numbers.
llvm-svn: 314617
2017-10-01 03:47:02 +00:00
Rui Ueyama 432342b6a8 Update the monorepo URL in a lld's document.
llvm-svn: 313396
2017-09-15 21:04:43 +00:00
Rui Ueyama 42fca6e794 Recommend users use readelf instead of objdump to dump .comment contents.
readelf's output is much easier to read than objdump's as you can see below.

  $ readelf --string-dump .comment foo
  String dump of section '.comment':
    [     1]  GCC: (Ubuntu 4.8.4-2ubuntu1~14.04.3) 4.8.4
    [    2c]  clang version 5.0.0
    [    41]  Linker: LLD 5.0.0

  $ objdump -j .comment -s foo
  Contents of section .comment:
   0000 00474343 3a202855 62756e74 7520342e  .GCC: (Ubuntu 4.
   0010 382e342d 32756275 6e747531 7e31342e  8.4-2ubuntu1~14.
   0020 30342e33 2920342e 382e3400 636c616e  04.3) 4.8.4.clan
   0030 67207665 7273696f 6e20352e 302e3020  g version 5.0.0
   0040 004c696e 6b65723a 204c4c44 20352e30  .Linker: LLD 5.0
   0050 2e3000                               .0.

llvm-svn: 301515
2017-04-27 04:50:08 +00:00
Rui Ueyama 9a651672d0 Clarify benchmark conditions.
llvm-svn: 296383
2017-02-27 21:07:50 +00:00
Rui Ueyama 4d5f70ddea Fix rst markup.
llvm-svn: 296302
2017-02-26 22:17:46 +00:00
Rui Ueyama 81762abb6b Fix typo.
Pointed out by Piotr Padlewski.

llvm-svn: 296297
2017-02-26 18:32:31 +00:00
Rui Ueyama 19ce92e20c Add a section about how to use ld.lld.
llvm-svn: 296278
2017-02-26 00:20:42 +00:00
Rui Ueyama db895d839f Add how long it takes to link chromium using ld.bfd.
llvm-svn: 296236
2017-02-25 03:27:39 +00:00
Rui Ueyama 7c9f00e634 Fix rst document format error.
llvm-svn: 296235
2017-02-25 03:01:18 +00:00
Rui Ueyama bb361fcba1 Mention FreeBSD ports status and wordsmithing.
Differential Revision: https://reviews.llvm.org/D30321

llvm-svn: 296157
2017-02-24 18:54:47 +00:00
Rui Ueyama 0122142c57 Fix errors in the benchmark result.
I was mixing 1000 and 1024 when calculating file sizes in MiB or
in GiB.

llvm-svn: 296155
2017-02-24 18:50:58 +00:00
Rui Ueyama 8b1c940c0b Re-add ReleaseNotes to the doc tree.
Looks like it is not allowed to have an .rst file in this directory
that does not belong to a document tree. I don't know why. This patch
adds a file back to fix a bot.

llvm-svn: 296087
2017-02-24 04:23:39 +00:00
Rui Ueyama 1582e76abd Reorganize the document structure a bit.
C++11.rst is removed because LLD now follows the usual coding style
of the LLVM project.

llvm-svn: 296086
2017-02-24 04:13:08 +00:00
Rui Ueyama 741cc4be7e Add documents to a doctree.
Looks like all documents must be in a doctree.

llvm-svn: 296075
2017-02-24 02:46:03 +00:00
Rui Ueyama fca2a110ed Attempt to fix lld-sphinx-docs bot.
llvm-svn: 296074
2017-02-24 02:07:54 +00:00
Rui Ueyama 2698ab4b62 Update the main document of LLD for those who are not familiar with the project.
llvm-svn: 296072
2017-02-24 01:55:50 +00:00
Rui Ueyama 02aa766897 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
2016-03-12 06:06:40 +00:00
Rafael Espindola 79944f20ea Start adding release notes for lld.
llvm-svn: 260960
2016-02-16 13:12:55 +00:00
Rui Ueyama df06d203e5 Update documents.
llvm-svn: 253728
2015-11-20 22:47:42 +00:00
Rui Ueyama aa7b304ea7 Remove the Native file format.
The Native file format was designed to be the fastest on-memory or
on-disk file format for object files. The problem is that no one
is working on that. No LLVM tools can produce object files in
the Native, thus the feature of supporting the format is useless
in the linker.

This patch removes the Native file support. We can add it back
if we really want it in future.

llvm-svn: 234641
2015-04-10 21:23:51 +00:00
Nico Weber 9b839f8ced Tweak lld's checkout instructions.
llvm-svn: 224778
2014-12-23 18:52:41 +00:00
Ed Maste aaa317a1eb lld self-hosts on FreeBSD too
llvm-svn: 224448
2014-12-17 19:14:57 +00:00
Simon Atanasyan e747a44fe8 Update current LLD status for MIPS target.
llvm-svn: 217372
2014-09-08 14:56:20 +00:00
Michael J. Spencer 1dd276672f [docs] Update current status.
llvm-svn: 203188
2014-03-07 01:42:19 +00:00
Rui Ueyama 3e37326166 Add a document about Windows support.
llvm-svn: 203017
2014-03-05 22:35:32 +00:00
Michael J. Spencer ac4f444e39 [docs] lld self hosts.
llvm-svn: 174592
2013-02-07 07:26:45 +00:00
Michael J. Spencer 18950a174e [Docs] Update status :)
llvm-svn: 174162
2013-02-01 09:20:24 +00:00
Michael J. Spencer 31dffbb659 [docs] Update status.
llvm-svn: 172501
2013-01-15 02:00:48 +00:00
Michael J. Spencer 365f1ec246 [docs] Add getting started guide.
llvm-svn: 155578
2012-04-25 19:34:24 +00:00
Michael J. Spencer d01c8fe7a5 [docs] Make the index page ReST based instead of html based.
llvm-svn: 154275
2012-04-08 02:06:04 +00:00