Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / llvm / 5cda9016477b206d1d75b0e3a83ff1597a1f8d12 / . / docs / userguides.rst
blob: 0d1f3fb46aaed028e768c045585bdaa8f862d344 [file] [log] [blame]
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]1.. _userguides:
2
3User Guides
4===========
5
Daniel Dunbar17412a02012-05-08 16:50:43 +0000[diff] [blame]6.. toctree::
7 :hidden:
8
9 CommandGuide/index
Michael J. Spencer0ed5cf42012-06-18 20:21:38 +0000[diff] [blame]10 FAQ
Bill Wendling5cda9012012-06-20 10:36:41 +0000[diff] [blame^]11 Lexicon
Daniel Dunbar17412a02012-05-08 16:50:43 +0000[diff] [blame]12
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]13* `The LLVM Getting Started Guide <GettingStarted.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]14
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]15 Discusses how to get up and running quickly with the LLVM infrastructure.
16 Everything from unpacking and compilation of the distribution to execution
17 of some tools.
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]18
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]19* `LLVM CMake guide <CMake.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]20
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]21 An addendum to the main Getting Started guide for those using the `CMake
22 build system <http://www.cmake.org>`_.
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]23
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]24* `Getting Started with the LLVM System using Microsoft Visual Studio
25 <GettingStartedVS.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]26
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]27 An addendum to the main Getting Started guide for those using Visual Studio
28 on Windows.
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]29
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]30* `LLVM Tutorial <tutorial/>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]31
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]32 A walk through the process of using LLVM for a custom language, and the
33 facilities LLVM offers in tutorial form.
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]34
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]35* `Developer Policy <DeveloperPolicy.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]36
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]37 The LLVM project's policy towards developers and their contributions.
Daniel Dunbar17412a02012-05-08 16:50:43 +0000[diff] [blame]38
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]39* :ref:`LLVM Command Guide <commands>`
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]40
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]41 A reference manual for the LLVM command line utilities ("man" pages for LLVM
42 tools).
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]43
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]44* `LLVM's Analysis and Transform Passes <Passes.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]45
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]46 A list of optimizations and analyses implemented in LLVM.
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]47
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]48* :ref:`faq`
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]49
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]50 A list of common questions and problems and their solutions.
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]51
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]52* `Release notes for the current release <ReleaseNotes.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]53
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]54 This describes new features, known bugs, and other limitations.
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]55
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]56* `How to Submit A Bug Report <HowToSubmitABug.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]57
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]58 Instructions for properly submitting information about any bugs you run into
59 in the LLVM system.
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]60
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]61* `LLVM Testing Infrastructure Guide <TestingGuide.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]62
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]63 A reference manual for using the LLVM testing infrastructure.
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]64
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]65* `How to build the C, C++, ObjC, and ObjC++ front end <http://clang.llvm.org/get_started.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]66
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]67 Instructions for building the clang front-end from source.
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]68
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]69* `Packaging guide <Packaging.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]70
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]71 Advice on packaging LLVM into a distribution.
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]72
Bill Wendling5cda9012012-06-20 10:36:41 +0000[diff] [blame^]73* :ref:`lexicon`
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]74
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]75 Definition of acronyms, terms and concepts used in LLVM.
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]76
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]77* `How To Add Your Build Configuration To LLVM Buildbot Infrastructure <HowToAddABuilder.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]78
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]79 Instructions for adding new builder to LLVM buildbot master.
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]80
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]81* **IRC** -- You can probably find help on the unofficial LLVM IRC.
Daniel Dunbar21e993c2012-04-19 16:31:37 +0000[diff] [blame]82
Bill Wendling81e664b2012-06-20 09:48:38 +0000[diff] [blame]83 We often are on irc.oftc.net in the #llvm channel. If you are using the
84 mozilla browser, and have chatzilla installed, you can `join #llvm on
85 irc.oftc.net <irc://irc.oftc.net/llvm>`_.