blob: fe2604fbb7b593a821698affdc4733b82158fa08 [file] [log] [blame]
Daniel Dunbar21e993c2012-04-19 16:31:37 +00001.. _programming:
2
3Programming Documentation
4=========================
5
Bill Wendlingeef31a52012-06-20 11:56:24 +00006.. toctree::
7 :hidden:
8
9 CodingStandards
Bill Wendling0bd3dee2012-08-08 08:21:24 +000010 CommandLine
Sean Silva258aeb52012-09-21 02:46:32 +000011 Atomics
Sean Silva36be1ae2012-10-05 03:32:01 +000012 HowToSetUpLLVMStyleRTTI
Bill Wendlingeef31a52012-06-20 11:56:24 +000013
Bill Wendlingaf5e2e72012-06-20 11:55:22 +000014* `LLVM Language Reference Manual <LangRef.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000015
Bill Wendlingaf5e2e72012-06-20 11:55:22 +000016 Defines the LLVM intermediate representation and the assembly form of the
17 different nodes.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000018
Sean Silva258aeb52012-09-21 02:46:32 +000019* :ref:`atomics`
20
21 Information about LLVM's concurrency model.
22
Bill Wendlingaf5e2e72012-06-20 11:55:22 +000023* `The LLVM Programmers Manual <ProgrammersManual.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000024
Bill Wendlingaf5e2e72012-06-20 11:55:22 +000025 Introduction to the general layout of the LLVM sourcebase, important classes
26 and APIs, and some tips & tricks.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000027
Bill Wendling0bd3dee2012-08-08 08:21:24 +000028* :ref:`commandline`
Daniel Dunbar21e993c2012-04-19 16:31:37 +000029
Bill Wendlingaf5e2e72012-06-20 11:55:22 +000030 Provides information on using the command line parsing library.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000031
Bill Wendlingeef31a52012-06-20 11:56:24 +000032* :ref:`coding_standards`
Daniel Dunbar21e993c2012-04-19 16:31:37 +000033
Bill Wendlingaf5e2e72012-06-20 11:55:22 +000034 Details the LLVM coding standards and provides useful information on writing
35 efficient C++ code.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000036
Sean Silva36be1ae2012-10-05 03:32:01 +000037* :doc:`HowToSetUpLLVMStyleRTTI`
38
39 How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
40 class hierarchy.
41
Bill Wendlingaf5e2e72012-06-20 11:55:22 +000042* `Extending LLVM <ExtendingLLVM.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000043
Bill Wendlingaf5e2e72012-06-20 11:55:22 +000044 Look here to see how to add instructions and intrinsics to LLVM.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000045
Bill Wendlingaf5e2e72012-06-20 11:55:22 +000046* `Doxygen generated documentation <http://llvm.org/doxygen/>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000047
Bill Wendlingaf5e2e72012-06-20 11:55:22 +000048 (`classes <http://llvm.org/doxygen/inherits.html>`_)
49 (`tarball <http://llvm.org/doxygen/doxygen.tar.gz>`_)
Daniel Dunbar21e993c2012-04-19 16:31:37 +000050
Bill Wendlingaf5e2e72012-06-20 11:55:22 +000051* `ViewVC Repository Browser <http://llvm.org/viewvc/>`_