blob: 918e1778b801c0edf47e94596dda0c9f84c3db1d [file] [log] [blame]
Daniel Dunbareaa88c82012-04-06 23:47:34 +00001.. _development:
2
3Development
4===========
5
6lld is developed as part of the `LLVM <http://llvm.org>`_ project.
7
Michael J. Spencer359e09d2013-01-20 10:39:17 +00008Using C++11 in lld
9------------------
10
11:doc:`C++11`.
12
Nick Kledzikb47d6ca2012-06-12 22:43:35 +000013Creating a Reader
14-----------------
15
16See the :ref:`Creating a Reader <Readers>` guide.
17
18
Michael J. Spencered195072013-01-15 02:00:59 +000019Modifying the Driver
20--------------------
21
22See :doc:`Driver`.
23
24
Rui Ueyamaeaadec32013-05-10 22:19:28 +000025Debugging
26---------
27
Rui Ueyama0227be62013-05-11 00:26:26 +000028You can run lld with ``-mllvm -debug`` command line options to enable debugging
Rui Ueyamaeaadec32013-05-10 22:19:28 +000029printouts. If you want to enable debug information for some specific pass, you
Rui Ueyama0227be62013-05-11 00:26:26 +000030can run it with ``-mllvm '-debug-only=<pass>'``, where pass is a name used in
Rui Ueyamaeaadec32013-05-10 22:19:28 +000031the ``DEBUG_WITH_TYPE()`` macro.
32
33
Nick Kledzikb47d6ca2012-06-12 22:43:35 +000034
35Documentation
36-------------
Daniel Dunbareaa88c82012-04-06 23:47:34 +000037
38The project documentation is written in reStructuredText and generated using the
39`Sphinx <http://sphinx.pocoo.org/>`_ documentation generator. For more
40information on writing documentation for the project, see the
41:ref:`sphinx_intro`.
Nick Kledzik920cedd2012-06-18 20:24:47 +000042
43.. toctree::
44 :hidden:
45
Michael J. Spencer359e09d2013-01-20 10:39:17 +000046 C++11
Nick Kledzik920cedd2012-06-18 20:24:47 +000047 Readers
Michael J. Spencered195072013-01-15 02:00:59 +000048 Driver