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