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