docs/programming.rst

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