Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 5d499c2de415dabf2c5d4f72d1a62e060e601583 / . / docs / userguides.rst
blob: 94f72187243f184d40de215f3d03b679b029c2d8 [file] [log] [blame]
Micah Villmow593c0b02012-09-27 17:51:02 +0000[diff] [blame]1.. _userguides:
2
3User Guides
4===========
5
6.. toctree::
7 :hidden:
8
9 CMake
10 HowToBuildOnARM
11 CommandGuide/index
12 DeveloperPolicy
Bill Wendlingf93c55a2012-10-07 07:10:13 +0000[diff] [blame]13 GettingStarted
Micah Villmow593c0b02012-09-27 17:51:02 +0000[diff] [blame]14 GettingStartedVS
15 FAQ
16 Lexicon
17 Packaging
18 HowToAddABuilder
19 yaml2obj
Sean Silva87ed5532012-09-25 20:52:04 +0000[diff] [blame]20 HowToSubmitABug
Sean Silva5d499c22012-10-12 00:53:48 +0000[diff] [blame^]21 SphinxQuickstartTemplate
Micah Villmow593c0b02012-09-27 17:51:02 +0000[diff] [blame]22
Bill Wendlingf93c55a2012-10-07 07:10:13 +0000[diff] [blame]23* :ref:`getting_started`
Micah Villmow593c0b02012-09-27 17:51:02 +0000[diff] [blame]24
25 Discusses how to get up and running quickly with the LLVM infrastructure.
26 Everything from unpacking and compilation of the distribution to execution
27 of some tools.
28
29* :ref:`building-with-cmake`
30
31 An addendum to the main Getting Started guide for those using the `CMake
32 build system <http://www.cmake.org>`_.
33
34* :ref:`how_to_build_on_arm`
35
36 Notes on building and testing LLVM/Clang on ARM.
37
38* `Getting Started with the LLVM System using Microsoft Visual Studio
39 <GettingStartedVS.html>`_
40
41 An addendum to the main Getting Started guide for those using Visual Studio
42 on Windows.
43
44* `LLVM Tutorial <tutorial/>`_
45
46 A walk through the process of using LLVM for a custom language, and the
47 facilities LLVM offers in tutorial form.
48
49* :ref:`developer_policy`
50
51 The LLVM project's policy towards developers and their contributions.
52
53* :ref:`LLVM Command Guide <commands>`
54
55 A reference manual for the LLVM command line utilities ("man" pages for LLVM
56 tools).
57
58* `LLVM's Analysis and Transform Passes <Passes.html>`_
59
60 A list of optimizations and analyses implemented in LLVM.
61
62* :ref:`faq`
63
64 A list of common questions and problems and their solutions.
65
66* `Release notes for the current release <ReleaseNotes.html>`_
67
68 This describes new features, known bugs, and other limitations.
69
Sean Silva87ed5532012-09-25 20:52:04 +0000[diff] [blame]70* :ref:`how-to-submit-a-bug-report`
Micah Villmow593c0b02012-09-27 17:51:02 +0000[diff] [blame]71
72 Instructions for properly submitting information about any bugs you run into
73 in the LLVM system.
Sean Silva5d499c22012-10-12 00:53:48 +0000[diff] [blame^]74* :doc:`SphinxQuickstartTemplate`
75
76 A template + tutorial for writing new Sphinx documentation. It is meant
77 to be read in source form.
Micah Villmow593c0b02012-09-27 17:51:02 +0000[diff] [blame]78
79* `LLVM Testing Infrastructure Guide <TestingGuide.html>`_
80
81 A reference manual for using the LLVM testing infrastructure.
82
83* `How to build the C, C++, ObjC, and ObjC++ front end <http://clang.llvm.org/get_started.html>`_
84
85 Instructions for building the clang front-end from source.
86
87* :ref:`packaging`
88
89 Advice on packaging LLVM into a distribution.
90
91* :ref:`lexicon`
92
93 Definition of acronyms, terms and concepts used in LLVM.
94
95* :ref:`how_to_add_a_builder`
96
97 Instructions for adding new builder to LLVM buildbot master.
98
99* **IRC** -- You can probably find help on the unofficial LLVM IRC.
100
101 We often are on irc.oftc.net in the #llvm channel. If you are using the
102 mozilla browser, and have chatzilla installed, you can `join #llvm on
103 irc.oftc.net <irc://irc.oftc.net/llvm>`_.