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