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