llvm/docs/programming.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

57 lines
1.3 KiB
ReStructuredText

Programming Documentation
=========================
.. toctree::
:hidden:
Atomics
CodingStandards
CommandLine
CompilerWriterInfo
ExtendingLLVM
HowToSetUpLLVMStyleRTTI
ProgrammersManual
* :doc:`LLVM Language Reference Manual <LangRef>`
Defines the LLVM intermediate representation and the assembly form of the
different nodes.
* :doc:`Atomics`
Information about LLVM's concurrency model.
* :doc:`ProgrammersManual`
Introduction to the general layout of the LLVM sourcebase, important classes
and APIs, and some tips & tricks.
* :doc:`CommandLine`
Provides information on using the command line parsing library.
* :doc:`CodingStandards`
Details the LLVM coding standards and provides useful information on writing
efficient C++ code.
* :doc:`HowToSetUpLLVMStyleRTTI`
How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
class hierarchy.
* :doc:`ExtendingLLVM`
Look here to see how to add instructions and intrinsics to LLVM.
* `Doxygen generated documentation <http://llvm.org/doxygen/>`_
(`classes <http://llvm.org/doxygen/inherits.html>`_)
(`tarball <http://llvm.org/doxygen/doxygen.tar.gz>`_)
* `ViewVC Repository Browser <http://llvm.org/viewvc/>`_
* :doc:`CompilerWriterInfo`
A list of helpful links for compiler writers.