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