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