Sphinxify the compiler writer info documentation.
[oota-llvm.git] / docs / programming.rst
1 .. _programming:
2
3 Programming Documentation
4 =========================
5
6 .. toctree::
7    :hidden:
8
9    CodingStandards
10    CommandLine
11    CompilerWriterInfo
12    Atomics
13    HowToSetUpLLVMStyleRTTI
14
15 * `LLVM Language Reference Manual <LangRef.html>`_
16
17   Defines the LLVM intermediate representation and the assembly form of the
18   different nodes.
19
20 * :ref:`atomics`
21
22   Information about LLVM's concurrency model.
23
24 * `The LLVM Programmers Manual <ProgrammersManual.html>`_
25
26   Introduction to the general layout of the LLVM sourcebase, important classes
27   and APIs, and some tips & tricks.
28
29 * :ref:`commandline`
30
31   Provides information on using the command line parsing library.
32
33 * :ref:`coding_standards`
34
35   Details the LLVM coding standards and provides useful information on writing
36   efficient C++ code.
37
38 * :doc:`HowToSetUpLLVMStyleRTTI`
39
40   How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
41   class hierarchy.
42
43 * `Extending LLVM <ExtendingLLVM.html>`_
44
45   Look here to see how to add instructions and intrinsics to LLVM.
46
47 * `Doxygen generated documentation <http://llvm.org/doxygen/>`_
48
49   (`classes <http://llvm.org/doxygen/inherits.html>`_)
50   (`tarball <http://llvm.org/doxygen/doxygen.tar.gz>`_)
51
52 * `ViewVC Repository Browser <http://llvm.org/viewvc/>`_
53
54 * :ref:`compiler_writer_info`
55
56   A list of helpful links for compiler writers.