2012-09-27 17:51:02 +00:00
|
|
|
.. _userguides:
|
|
|
|
|
|
|
|
|
|
User Guides
|
|
|
|
|
===========
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:hidden:
|
|
|
|
|
|
|
|
|
|
CMake
|
|
|
|
|
HowToBuildOnARM
|
|
|
|
|
CommandGuide/index
|
|
|
|
|
DeveloperPolicy
|
2012-10-07 07:10:13 +00:00
|
|
|
GettingStarted
|
2012-09-27 17:51:02 +00:00
|
|
|
GettingStartedVS
|
|
|
|
|
FAQ
|
|
|
|
|
Lexicon
|
|
|
|
|
Packaging
|
|
|
|
|
HowToAddABuilder
|
|
|
|
|
yaml2obj
|
2012-09-25 20:52:04 +00:00
|
|
|
HowToSubmitABug
|
2012-10-12 00:53:48 +00:00
|
|
|
SphinxQuickstartTemplate
|
2012-10-12 01:21:24 +00:00
|
|
|
Phabricator
|
2012-11-14 21:09:30 +00:00
|
|
|
TestingGuide
|
2012-12-04 21:16:41 +00:00
|
|
|
tutorial/index
|
2012-12-09 23:14:26 +00:00
|
|
|
ReleaseNotes
|
2012-12-12 17:02:44 +00:00
|
|
|
Passes
|
2012-12-12 20:46:15 +00:00
|
|
|
YamlIO
|
2012-09-27 17:51:02 +00:00
|
|
|
|
2012-10-07 07:10:13 +00:00
|
|
|
* :ref:`getting_started`
|
2012-09-27 17:51:02 +00:00
|
|
|
|
|
|
|
|
Discusses how to get up and running quickly with the LLVM infrastructure.
|
|
|
|
|
Everything from unpacking and compilation of the distribution to execution
|
|
|
|
|
of some tools.
|
|
|
|
|
|
|
|
|
|
* :ref:`building-with-cmake`
|
|
|
|
|
|
|
|
|
|
An addendum to the main Getting Started guide for those using the `CMake
|
|
|
|
|
build system <http://www.cmake.org>`_.
|
|
|
|
|
|
|
|
|
|
* :ref:`how_to_build_on_arm`
|
|
|
|
|
|
|
|
|
|
Notes on building and testing LLVM/Clang on ARM.
|
|
|
|
|
|
2012-12-04 21:16:34 +00:00
|
|
|
* :doc:`GettingStartedVS`
|
2012-09-27 17:51:02 +00:00
|
|
|
|
|
|
|
|
An addendum to the main Getting Started guide for those using Visual Studio
|
|
|
|
|
on Windows.
|
|
|
|
|
|
2012-12-04 21:16:41 +00:00
|
|
|
* :doc:`tutorial/index`
|
2012-09-27 17:51:02 +00:00
|
|
|
|
|
|
|
|
A walk through the process of using LLVM for a custom language, and the
|
|
|
|
|
facilities LLVM offers in tutorial form.
|
|
|
|
|
|
|
|
|
|
* :ref:`developer_policy`
|
|
|
|
|
|
|
|
|
|
The LLVM project's policy towards developers and their contributions.
|
|
|
|
|
|
|
|
|
|
* :ref:`LLVM Command Guide <commands>`
|
|
|
|
|
|
|
|
|
|
A reference manual for the LLVM command line utilities ("man" pages for LLVM
|
|
|
|
|
tools).
|
|
|
|
|
|
2012-12-12 17:02:44 +00:00
|
|
|
* :doc:`Passes`
|
2012-09-27 17:51:02 +00:00
|
|
|
|
|
|
|
|
A list of optimizations and analyses implemented in LLVM.
|
2012-12-12 17:02:44 +00:00
|
|
|
|
2012-09-27 17:51:02 +00:00
|
|
|
* :ref:`faq`
|
|
|
|
|
|
|
|
|
|
A list of common questions and problems and their solutions.
|
|
|
|
|
|
2012-12-09 23:14:26 +00:00
|
|
|
* :doc:`Release notes for the current release <ReleaseNotes>`
|
2012-09-27 17:51:02 +00:00
|
|
|
|
|
|
|
|
This describes new features, known bugs, and other limitations.
|
|
|
|
|
|
2012-09-25 20:52:04 +00:00
|
|
|
* :ref:`how-to-submit-a-bug-report`
|
2012-09-27 17:51:02 +00:00
|
|
|
|
|
|
|
|
Instructions for properly submitting information about any bugs you run into
|
|
|
|
|
in the LLVM system.
|
2012-10-12 00:53:48 +00:00
|
|
|
* :doc:`SphinxQuickstartTemplate`
|
|
|
|
|
|
|
|
|
|
A template + tutorial for writing new Sphinx documentation. It is meant
|
|
|
|
|
to be read in source form.
|
2012-09-27 17:51:02 +00:00
|
|
|
|
2012-11-14 21:09:30 +00:00
|
|
|
* :doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
|
2012-09-27 17:51:02 +00:00
|
|
|
|
|
|
|
|
A reference manual for using the LLVM testing infrastructure.
|
|
|
|
|
|
|
|
|
|
* `How to build the C, C++, ObjC, and ObjC++ front end <http://clang.llvm.org/get_started.html>`_
|
|
|
|
|
|
|
|
|
|
Instructions for building the clang front-end from source.
|
|
|
|
|
|
|
|
|
|
* :ref:`packaging`
|
|
|
|
|
|
|
|
|
|
Advice on packaging LLVM into a distribution.
|
|
|
|
|
|
|
|
|
|
* :ref:`lexicon`
|
|
|
|
|
|
|
|
|
|
Definition of acronyms, terms and concepts used in LLVM.
|
|
|
|
|
|
|
|
|
|
* :ref:`how_to_add_a_builder`
|
|
|
|
|
|
|
|
|
|
Instructions for adding new builder to LLVM buildbot master.
|
|
|
|
|
|
2012-12-12 20:46:15 +00:00
|
|
|
* :ref:`yamlio`
|
|
|
|
|
|
|
|
|
|
A reference guide for using LLVM's YAML I/O library.
|
|
|
|
|
|
2012-09-27 17:51:02 +00:00
|
|
|
* **IRC** -- You can probably find help on the unofficial LLVM IRC.
|
|
|
|
|
|
|
|
|
|
We often are on irc.oftc.net in the #llvm channel. If you are using the
|
|
|
|
|
mozilla browser, and have chatzilla installed, you can `join #llvm on
|
|
|
|
|
irc.oftc.net <irc://irc.oftc.net/llvm>`_.
|
