llvm-6502/docs/userguides.rst
Sean Silva a7aec400a7 docs: Fix long standing linking antipattern.
Before we learned about :doc:, we used :ref: and put a dummy link at the
top of each page. Don't do that anymore.

This fixes PR14891 as a special case.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@172162 91177308-0d34-0410-b5e6-96231b3b80d8
2013-01-11 02:28:08 +00:00

111 lines
2.7 KiB
ReStructuredText

User Guides
===========
.. toctree::
:hidden:
CMake
HowToBuildOnARM
CommandGuide/index
DeveloperPolicy
GettingStarted
GettingStartedVS
FAQ
Lexicon
Packaging
HowToAddABuilder
yaml2obj
HowToSubmitABug
SphinxQuickstartTemplate
Phabricator
TestingGuide
tutorial/index
ReleaseNotes
Passes
YamlIO
* :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:`CMake`
An addendum to the main Getting Started guide for those using the `CMake
build system <http://www.cmake.org>`_.
* :doc:`HowToBuildOnARM`
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.
* :doc:`tutorial/index`
Tutorials about using LLVM. Includes a tutorial about making a custom
language with LLVM.
* :doc:`DeveloperPolicy`
The LLVM project's policy towards developers and their contributions.
* :doc:`LLVM Command Guide <CommandGuide/index>`
A reference manual for the LLVM command line utilities ("man" pages for LLVM
tools).
* :doc:`Passes`
A list of optimizations and analyses implemented in LLVM.
* :doc:`FAQ`
A list of common questions and problems and their solutions.
* :doc:`Release notes for the current release <ReleaseNotes>`
This describes new features, known bugs, and other limitations.
* :doc:`HowToSubmitABug`
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.
* :doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
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.
* :doc:`Packaging`
Advice on packaging LLVM into a distribution.
* :doc:`Lexicon`
Definition of acronyms, terms and concepts used in LLVM.
* :doc:`HowToAddABuilder`
Instructions for adding new builder to LLVM buildbot master.
* :doc:`YamlIO`
A reference guide for using LLVM's YAML I/O library.
* **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>`_.