105 lines · plain
1About2========3 4.. warning::5 6 If you are using a released version of LLVM, see `the download page7 <https://llvm.org/releases/>`_ to find your documentation.8 9The LLVM compiler infrastructure supports a wide range of projects, from10industrial strength compilers to specialized JIT applications to small11research projects.12 13Similarly, documentation is broken down into several high-level groupings14targeted at different audiences:15 16LLVM Design & Overview17======================18 19Several introductory papers and presentations.20 21.. toctree::22 :hidden:23 24 FAQ25 Lexicon26 27:doc:`FAQ`28 Frequently asked questions.29 30:doc:`Lexicon`31 Glossary.32 33`Introduction to the LLVM Compiler`__34 Presentation providing a users introduction to LLVM.35 36 .. __: https://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html37 38`Intro to LLVM`__39 A chapter from the book "The Architecture of Open Source Applications" that40 describes high-level design decisions that shaped LLVM.41 42 .. __: http://www.aosabook.org/en/llvm.html43 44 45`LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation`__46 Design overview.47 48 .. __: https://llvm.org/pubs/2004-01-30-CGO-LLVM.html49 50`LLVM: An Infrastructure for Multi-Stage Optimization`__51 More details (quite old now).52 53 .. __: https://llvm.org/pubs/2002-12-LattnerMSThesis.html54 55Documentation56=============57 58Getting Started, How-tos, Developer Guides, and Tutorials.59 60.. toctree::61 :hidden:62 63 GettingStartedTutorials64 Reference65 UserGuides66 DiscourseMigrationGuide67 68:doc:`GettingStartedTutorials`69 For those new to the LLVM system.70 71:doc:`UserGuides`72 User guides and How-tos.73 74:doc:`Reference`75 LLVM and API reference documentation.76 77:doc:`DiscourseMigrationGuide`78 Guide for users to migrate to Discourse79 80Community81=========82 83LLVM welcomes contributions of all kinds. To learn more, see the following articles:84 85.. toctree::86 :hidden:87 88 GettingInvolved89 90* :doc:`GettingInvolved`91* :ref:`development-process`92* :ref:`lists-forums`93* :ref:`meetups-social-events`94* :ref:`community-proposals`95 96 Reporting a security issue97 98* :ref:`report-security-issue`99 100Indices and tables101==================102 103* :ref:`genindex`104* :ref:`search`105