1.. _development:
2
3Development
4===========
5
6Note: this document discuss Mach-O port of LLD. For ELF and COFF,
7see :doc:`index`.
8
9lld is developed as part of the `LLVM <http://llvm.org>`_ project.
10
11Creating a Reader
12-----------------
13
14See the :ref:`Creating a Reader <Readers>` guide.
15
16
17Modifying the Driver
18--------------------
19
20See :doc:`Driver`.
21
22
23Debugging
24---------
25
26You can run lld with ``-mllvm -debug`` command line options to enable debugging
27printouts. If you want to enable debug information for some specific pass, you
28can run it with ``-mllvm '-debug-only=<pass>'``, where pass is a name used in
29the ``DEBUG_WITH_TYPE()`` macro.
30
31
32
33Documentation
34-------------
35
36The project documentation is written in reStructuredText and generated using the
37`Sphinx <http://sphinx.pocoo.org/>`_ documentation generator. For more
38information on writing documentation for the project, see the
39:ref:`sphinx_intro`.
40
41.. toctree::
42   :hidden:
43
44   Readers
45   Driver
46