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