docs/programming.rst

   1 Programming Documentation
   2 =========================
   3
   4 .. toctree::
   5    :hidden:
   6
   7    Atomics
   8    CodingStandards
   9    CommandLine
  10    CompilerWriterInfo
  11    ExtendingLLVM
  12    HowToSetUpLLVMStyleRTTI
  13    ProgrammersManual
  14
  15 * :doc:`LLVM Language Reference Manual <LangRef>`
  16
  17   Defines the LLVM intermediate representation and the assembly form of the
  18   different nodes.
  19
  20 * :doc:`Atomics`
  21
  22   Information about LLVM's concurrency model.
  23
  24 * :doc:`ProgrammersManual`
  25
  26   Introduction to the general layout of the LLVM sourcebase, important classes
  27   and APIs, and some tips & tricks.
  28
  29 * :doc:`CommandLine`
  30
  31   Provides information on using the command line parsing library.
  32
  33 * :doc:`CodingStandards`
  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 * :doc:`ExtendingLLVM`
  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 * :doc:`CompilerWriterInfo`
  55
  56   A list of helpful links for compiler writers.