llvm-project/lld/docs
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
..
_static
_templates
llvm-theme Partially revert r287009: Remove trailing whitespace. 2016-11-15 19:09:13 +00:00
AtomLLD.rst Add notes about the scope of the documents. 2017-02-24 04:31:08 +00:00
CMakeLists.txt Add support for building Sphinx documentation when being built inside LLVM source tree and using CMake. 2014-04-18 21:59:05 +00:00
Driver.rst Add notes about the scope of the documents. 2017-02-24 04:31:08 +00:00
NewLLD.rst Improve the documentation. Patch from genewitch. Found on https://github.com/llvm-mirror/lld/pull/5 2017-03-02 10:40:24 +00:00
README.txt
Readers.rst Add notes about the scope of the documents. 2017-02-24 04:31:08 +00:00
ReleaseNotes.rst Don't try to link to the 4.0 release notes 2017-02-09 23:27:17 +00:00
conf.py Update docs/conf.py version 2017-01-12 21:43:32 +00:00
design.rst Add notes about the scope of the documents. 2017-02-24 04:31:08 +00:00
development.rst Add notes about the scope of the documents. 2017-02-24 04:31:08 +00:00
getting_started.rst getting_started.rst: fix 'unknown target name' error 2016-01-27 17:54:35 +00:00
hello.png Partially revert r287009: Remove trailing whitespace. 2016-11-15 19:09:13 +00:00
index.rst Recommend users use readelf instead of objdump to dump .comment contents. 2017-04-27 04:50:08 +00:00
make.bat
open_projects.rst Remove links to deleted TODOs. 2016-04-16 11:11:56 +00:00
sphinx_intro.rst
windows_support.rst Remove trailing whitespace. 2016-10-05 20:09:50 +00:00

README.txt

lld Documentation
=================

The lld documentation is written using the Sphinx documentation generator. It is
currently tested with Sphinx 1.1.3.

We currently use the 'nature' theme and a Beaker inspired structure.

To rebuild documents into html:

   [/lld/docs]> make html