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