2012-04-19 16:31:37 +00:00
|
|
|
Overview
|
|
|
|
|
========
|
|
|
|
|
|
|
|
|
|
.. warning::
|
|
|
|
|
|
|
|
|
|
If you are using a released version of LLVM, see `the download page
|
|
|
|
|
<http://llvm.org/releases/>`_ to find your documentation.
|
|
|
|
|
|
|
|
|
|
The LLVM compiler infrastructure supports a wide range of projects, from
|
|
|
|
|
industrial strength compilers to specialized JIT applications to small
|
|
|
|
|
research projects.
|
|
|
|
|
|
|
|
|
|
Similarly, documentation is broken down into several high-level groupings
|
2012-06-02 10:20:22 +00:00
|
|
|
targeted at different audiences:
|
2012-04-19 16:31:37 +00:00
|
|
|
|
2012-09-28 21:18:37 +00:00
|
|
|
* **Design & Overview**
|
2012-04-19 16:31:37 +00:00
|
|
|
|
2012-09-28 21:18:37 +00:00
|
|
|
Several introductory papers and presentations are available at
|
2013-01-11 02:28:08 +00:00
|
|
|
:doc:`design_and_overview`.
|
2012-04-19 16:31:37 +00:00
|
|
|
|
2012-09-28 21:18:37 +00:00
|
|
|
* **Publications**
|
2012-04-19 16:31:37 +00:00
|
|
|
|
2012-09-28 21:18:37 +00:00
|
|
|
The list of `publications <http://llvm.org/pubs>`_ based on LLVM.
|
2012-04-19 16:31:37 +00:00
|
|
|
|
2012-09-28 21:18:37 +00:00
|
|
|
* **User Guides**
|
2012-04-19 16:31:37 +00:00
|
|
|
|
2013-01-11 02:28:08 +00:00
|
|
|
Those new to the LLVM system should first visit the :doc:`userguides`.
|
2012-04-19 16:31:37 +00:00
|
|
|
|
2012-09-28 21:18:37 +00:00
|
|
|
NOTE: If you are a user who is only interested in using LLVM-based
|
|
|
|
|
compilers, you should look into `Clang <http://clang.llvm.org>`_ or
|
|
|
|
|
`DragonEgg <http://dragonegg.llvm.org>`_ instead. The documentation here is
|
|
|
|
|
intended for users who have a need to work with the intermediate LLVM
|
|
|
|
|
representation.
|
2012-04-19 16:31:37 +00:00
|
|
|
|
2012-09-28 21:18:37 +00:00
|
|
|
* **API Clients**
|
2012-04-19 16:31:37 +00:00
|
|
|
|
2012-09-28 21:18:37 +00:00
|
|
|
Developers of applications which use LLVM as a library should visit the
|
2013-01-11 02:28:08 +00:00
|
|
|
:doc:`programming`.
|
2012-04-19 16:31:37 +00:00
|
|
|
|
2012-09-28 21:18:37 +00:00
|
|
|
* **Subsystems**
|
2012-04-19 16:31:37 +00:00
|
|
|
|
2012-09-28 21:18:37 +00:00
|
|
|
API clients and LLVM developers may be interested in the
|
2013-01-11 02:28:08 +00:00
|
|
|
:doc:`subsystems` documentation.
|
2012-04-19 16:31:37 +00:00
|
|
|
|
2012-09-28 21:18:37 +00:00
|
|
|
* **Development Process**
|
2012-04-19 16:31:37 +00:00
|
|
|
|
2012-09-28 21:18:37 +00:00
|
|
|
Additional documentation on the LLVM project can be found at
|
2013-01-11 02:28:08 +00:00
|
|
|
:doc:`development_process`.
|
2012-04-19 16:31:37 +00:00
|
|
|
|
2012-09-28 21:18:37 +00:00
|
|
|
* **Mailing Lists**
|
2012-04-19 16:31:37 +00:00
|
|
|
|
2013-01-11 02:28:08 +00:00
|
|
|
For more information, consider consulting the LLVM :doc:`mailing_lists`.
|
2012-04-19 16:31:37 +00:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
design_and_overview
|
|
|
|
|
userguides
|
|
|
|
|
programming
|
|
|
|
|
subsystems
|
|
|
|
|
development_process
|
|
|
|
|
mailing_lists
|
|
|
|
|
|
|
|
|
|
Indices and tables
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
|
* :ref:`search`
|
