.. toctree::
:hidden:
+ CMake
+ HowToBuildOnARM
CommandGuide/index
+ DeveloperPolicy
+ GettingStarted
+ GettingStartedVS
FAQ
-
-\
-
- * `The LLVM Getting Started Guide <GettingStarted.html>`_
+ Lexicon
+ Packaging
+ HowToAddABuilder
+ yaml2obj
+ HowToSubmitABug
+ SphinxQuickstartTemplate
+ Phabricator
+ TestingGuide
+ tutorial/index
+ ReleaseNotes
+
+* :ref:`getting_started`
- 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.
+ 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.
- * `LLVM CMake guide <CMake.html>`_
+* :ref:`building-with-cmake`
- An addendum to the main Getting Started guide for those using the `CMake
- build system <http://www.cmake.org>`_.
-
- * `Getting Started with the LLVM System using Microsoft Visual Studio
- <GettingStartedVS.html>`_
+ 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`
- An addendum to the main Getting Started guide for those using Visual Studio
- on Windows.
+ Notes on building and testing LLVM/Clang on ARM.
+
+* :doc:`GettingStartedVS`
+
+ An addendum to the main Getting Started guide for those using Visual Studio
+ on Windows.
- * `LLVM Tutorial <tutorial/>`_
+* :doc:`tutorial/index`
- A walk through the process of using LLVM for a custom language, and the
- facilities LLVM offers in tutorial form.
+ A walk through the process of using LLVM for a custom language, and the
+ facilities LLVM offers in tutorial form.
- * `Developer Policy <DeveloperPolicy.html>`_
+* :ref:`developer_policy`
- The LLVM project's policy towards developers and their contributions.
+ The LLVM project's policy towards developers and their contributions.
- * :ref:`LLVM Command Guide <commands>`
+* :ref:`LLVM Command Guide <commands>`
- A reference manual for the LLVM command line utilities ("man" pages for LLVM
- tools).
+ A reference manual for the LLVM command line utilities ("man" pages for LLVM
+ tools).
-
* `LLVM's Analysis and Transform Passes <Passes.html>`_
+* `LLVM's Analysis and Transform Passes <Passes.html>`_
- A list of optimizations and analyses implemented in LLVM.
+ A list of optimizations and analyses implemented in LLVM.
- * :ref:`faq`
+* :ref:`faq`
- A list of common questions and problems and their solutions.
+ A list of common questions and problems and their solutions.
- * `Release notes for the current release <ReleaseNotes.html>`_
+* :doc:`Release notes for the current release <ReleaseNotes>`
- This describes new features, known bugs, and other limitations.
+ This describes new features, known bugs, and other limitations.
- * `How to Submit A Bug Report <HowToSubmitABug.html>`_
+* :ref:`how-to-submit-a-bug-report`
- Instructions for properly submitting information about any bugs you run into
- in the LLVM system.
+ Instructions for properly submitting information about any bugs you run into
+ in the LLVM system.
+* :doc:`SphinxQuickstartTemplate`
+
+ A template + tutorial for writing new Sphinx documentation. It is meant
+ to be read in source form.
- * `LLVM Testing Infrastructure Guide <TestingGuide.html>`_
+* :doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
- A reference manual for using the LLVM testing infrastructure.
+ 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>`_
+* `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.
+ Instructions for building the clang front-end from source.
- * `Packaging guide <Packaging.html>`_
+* :ref:`packaging`
- Advice on packaging LLVM into a distribution.
+ Advice on packaging LLVM into a distribution.
- * `The LLVM Lexicon <Lexicon.html>`_
+* :ref:`lexicon`
- Definition of acronyms, terms and concepts used in LLVM.
+ Definition of acronyms, terms and concepts used in LLVM.
- * `How To Add Your Build Configuration To LLVM Buildbot Infrastructure <HowToAddABuilder.html>`_
+* :ref:`how_to_add_a_builder`
- Instructions for adding new builder to LLVM buildbot master.
+ Instructions for adding new builder to LLVM buildbot master.
- * **IRC** -- You can probably find help on the unofficial LLVM IRC.
+* **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>`_.
+ 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>`_.
projects / oota-llvm.git / blobdiff