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