+++ /dev/null
-Reference Documentation\r
-========================\r
-\r
-LLVM and API reference documentation.\r
-\r
-.. toctree::\r
- :hidden:\r
-\r
- CommandGuide/index\r
- TestingGuide\r
-\r
-:doc:`LLVM Language Reference Manual <LangRef>`\r
- Defines the LLVM intermediate representation and the assembly form of the\r
- different nodes.\r
-\r
-:doc:`LLVM Command Guide <CommandGuide/index>`\r
- A reference manual for the LLVM command line utilities ("man" pages for LLVM\r
- tools).\r
-\r
-:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`\r
- A reference manual for using the LLVM testing infrastructure.\r
-\r
-`Doxygen generated documentation <http://llvm.org/doxygen/>`_\r
- (`classes <http://llvm.org/doxygen/inherits.html>`_)\r
-\r
-`Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_\r
-\r
-`Github Source Repository Browser <http://github.com/llvm/llvm-project//>`_\r
- ..\r
-\r
HowToBuildWithPGO\r
HowToCrossCompileBuiltinsOnArm\r
HowToCrossCompileLLVM\r
- GettingStarted\r
GettingStartedVS\r
FAQ\r
- Lexicon\r
HowToAddABuilder\r
yaml2obj\r
MarkdownQuickstartTemplate\r
Phabricator\r
- tutorial/index\r
- ReleaseNotes\r
Passes\r
YamlIO\r
GetElementPtr\r
BuildingADistribution\r
Remarks\r
\r
-:doc:`GettingStarted`\r
- Discusses how to get up and running quickly with the LLVM infrastructure.\r
- Everything from unpacking and compilation of the distribution to execution\r
- of some tools.\r
-\r
:doc:`CMake`\r
An addendum to the main Getting Started guide for those using the `CMake\r
build system <http://www.cmake.org>`_.\r
An addendum to the main Getting Started guide for those using Visual Studio\r
on Windows.\r
\r
-:doc:`tutorial/index`\r
- Tutorials about using LLVM. Includes a tutorial about making a custom\r
- language with LLVM.\r
-\r
:doc:`Passes`\r
A list of optimizations and analyses implemented in LLVM.\r
\r
:doc:`FAQ`\r
A list of common questions and problems and their solutions.\r
\r
-:doc:`Release notes for the current release <ReleaseNotes>`\r
- This describes new features, known bugs, and other limitations.\r
-\r
:doc:`TestSuiteGuide`\r
Describes how to compile and run the test-suite benchmarks.\r
\r
\r
.. __: http://clang.llvm.org/get_started.html\r
\r
-:doc:`Lexicon`\r
- Definition of acronyms, terms and concepts used in LLVM.\r
-\r
:doc:`HowToAddABuilder`\r
Instructions for adding new builder to LLVM buildbot master.\r
\r
:hidden:
LangRef
+ Lexicon
:doc:`LangRef`
Defines the LLVM intermediate representation.
`Publications mentioning LLVM <http://llvm.org/pubs>`_
..
+:doc:`Lexicon`
+ Definition of acronyms, terms and concepts used in LLVM.
+
Documentation
=============
SubsystemDocumentation
ReferenceDocumentation
-
:doc:`UserGuides`
For those new to the LLVM system.
:doc:`SubsystemDocumentation`
For API clients and LLVM developers.
-:doc:`ReferenceDocumentation`
- LLVM and API reference documentation.
+Getting Started/Tutorials
+-------------------------
+
+.. toctree::
+ :hidden:
+
+ GettingStarted
+ tutorial/index
+
+:doc:`GettingStarted`
+ 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.
+
+:doc:`tutorial/index`
+ Tutorials about using LLVM. Includes a tutorial about making a custom
+ language with LLVM.
+
+Reference
+---------
+
+.. toctree::
+ :hidden:
+
+LLVM and API reference documentation.
+
+.. toctree::
+ :hidden:
+
+ CommandGuide/index
+ TestingGuide
+
+:doc:`LLVM Language Reference Manual <LangRef>`
+ Defines the LLVM intermediate representation and the assembly form of the
+ different nodes.
+
+:doc:`LLVM Command Guide <CommandGuide/index>`
+ A reference manual for the LLVM command line utilities ("man" pages for LLVM
+ tools).
+
+:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
+ A reference manual for using the LLVM testing infrastructure.
+
+`Doxygen generated documentation <http://llvm.org/doxygen/>`_
+ (`classes <http://llvm.org/doxygen/inherits.html>`_)
+
+`Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
+
+`Github Source Repository Browser <http://github.com/llvm/llvm-project//>`_
+ ..
Community
=========
HowToReleaseLLVM
Packaging
ReleaseProcess
+ ReleaseNotes
:doc:`Projects`
How-to guide and templates for new projects that *use* the LLVM
:doc:`Packaging`
Advice on packaging LLVM into a distribution.
+:doc:`Release notes for the current release <ReleaseNotes>`
+ This describes new features, known bugs, and other limitations.
+
Mailing Lists
-------------