llvm-project/lld/docs/development.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

46 lines
956 B
ReStructuredText
Raw Normal View History

.. _development:
Development
===========
Note: this document discuss Mach-O port of LLD. For ELF and COFF,
see :doc:`index`.
2020-03-23 05:42:03 +08:00
lld is developed as part of the `LLVM <https://llvm.org>`_ project.
Creating a Reader
-----------------
See the :ref:`Creating a Reader <Readers>` guide.
Modifying the Driver
--------------------
See :doc:`Driver`.
Debugging
---------
You can run lld with ``-mllvm -debug`` command line options to enable debugging
printouts. If you want to enable debug information for some specific pass, you
can run it with ``-mllvm '-debug-only=<pass>'``, where pass is a name used in
the ``DEBUG_WITH_TYPE()`` macro.
Documentation
-------------
The project documentation is written in reStructuredText and generated using the
`Sphinx <http://sphinx.pocoo.org/>`_ documentation generator. For more
information on writing documentation for the project, see the
:ref:`sphinx_intro`.
.. toctree::
:hidden:
Readers
Driver