| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 1 | Overview |
| 2 | ======== |
| 3 | |
| 4 | .. warning:: |
| 5 | |
| 6 | If you are using a released version of LLVM, see `the download page |
| 7 | <http://llvm.org/releases/>`_ to find your documentation. |
| 8 | |
| 9 | The LLVM compiler infrastructure supports a wide range of projects, from |
| 10 | industrial strength compilers to specialized JIT applications to small |
| 11 | research projects. |
| 12 | |
| 13 | Similarly, documentation is broken down into several high-level groupings |
| Benjamin Kramer | d9b0b02 | 2012-06-02 10:20:22 +0000 | [diff] [blame] | 14 | targeted at different audiences: |
| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 15 | |
| Sean Silva | 74a19f0 | 2012-09-28 21:18:37 +0000 | [diff] [blame] | 16 | * **Design & Overview** |
| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 17 | |
| Sean Silva | 74a19f0 | 2012-09-28 21:18:37 +0000 | [diff] [blame] | 18 | Several introductory papers and presentations are available at |
| Sean Silva | a7aec40 | 2013-01-11 02:28:08 +0000 | [diff] [blame] | 19 | :doc:`design_and_overview`. |
| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 20 | |
| Sean Silva | 74a19f0 | 2012-09-28 21:18:37 +0000 | [diff] [blame] | 21 | * **Publications** |
| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 22 | |
| Sean Silva | 74a19f0 | 2012-09-28 21:18:37 +0000 | [diff] [blame] | 23 | The list of `publications <http://llvm.org/pubs>`_ based on LLVM. |
| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 24 | |
| Sean Silva | 74a19f0 | 2012-09-28 21:18:37 +0000 | [diff] [blame] | 25 | * **User Guides** |
| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 26 | |
| Sean Silva | a7aec40 | 2013-01-11 02:28:08 +0000 | [diff] [blame] | 27 | Those new to the LLVM system should first visit the :doc:`userguides`. |
| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 28 | |
| Sean Silva | 74a19f0 | 2012-09-28 21:18:37 +0000 | [diff] [blame] | 29 | NOTE: If you are a user who is only interested in using LLVM-based |
| 30 | compilers, you should look into `Clang <http://clang.llvm.org>`_ or |
| 31 | `DragonEgg <http://dragonegg.llvm.org>`_ instead. The documentation here is |
| 32 | intended for users who have a need to work with the intermediate LLVM |
| 33 | representation. |
| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 34 | |
| Sean Silva | 74a19f0 | 2012-09-28 21:18:37 +0000 | [diff] [blame] | 35 | * **API Clients** |
| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 36 | |
| Sean Silva | 74a19f0 | 2012-09-28 21:18:37 +0000 | [diff] [blame] | 37 | Developers of applications which use LLVM as a library should visit the |
| Sean Silva | a7aec40 | 2013-01-11 02:28:08 +0000 | [diff] [blame] | 38 | :doc:`programming`. |
| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 39 | |
| Sean Silva | 74a19f0 | 2012-09-28 21:18:37 +0000 | [diff] [blame] | 40 | * **Subsystems** |
| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 41 | |
| Sean Silva | 74a19f0 | 2012-09-28 21:18:37 +0000 | [diff] [blame] | 42 | API clients and LLVM developers may be interested in the |
| Sean Silva | a7aec40 | 2013-01-11 02:28:08 +0000 | [diff] [blame] | 43 | :doc:`subsystems` documentation. |
| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 44 | |
| Sean Silva | 74a19f0 | 2012-09-28 21:18:37 +0000 | [diff] [blame] | 45 | * **Development Process** |
| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 46 | |
| Sean Silva | 74a19f0 | 2012-09-28 21:18:37 +0000 | [diff] [blame] | 47 | Additional documentation on the LLVM project can be found at |
| Sean Silva | a7aec40 | 2013-01-11 02:28:08 +0000 | [diff] [blame] | 48 | :doc:`development_process`. |
| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 49 | |
| Sean Silva | 74a19f0 | 2012-09-28 21:18:37 +0000 | [diff] [blame] | 50 | * **Mailing Lists** |
| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 51 | |
| Sean Silva | a7aec40 | 2013-01-11 02:28:08 +0000 | [diff] [blame] | 52 | For more information, consider consulting the LLVM :doc:`mailing_lists`. |
| Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 53 | |
| 54 | .. toctree:: |
| 55 | :maxdepth: 2 |
| 56 | |
| 57 | design_and_overview |
| 58 | userguides |
| 59 | programming |
| 60 | subsystems |
| 61 | development_process |
| 62 | mailing_lists |
| 63 | |
| 64 | Indices and tables |
| 65 | ================== |
| 66 | |
| 67 | * :ref:`genindex` |
| 68 | * :ref:`search` |