lld/docs/development.rst

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