blob: e8acc1d2e0c87f944736768fbc024c2c612f14bd [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
Bill Wendling53960a62012-10-07 04:34:10 +000011 CompilerWriterInfo
Sean Silva258aeb52012-09-21 02:46:32 +000012 Atomics
Sean Silva36be1ae2012-10-05 03:32:01 +000013 HowToSetUpLLVMStyleRTTI
Bill Wendlingeef31a52012-06-20 11:56:24 +000014
Bill Wendlingaf5e2e72012-06-20 11:55:22 +000015* `LLVM Language Reference Manual <LangRef.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000016
Bill Wendlingaf5e2e72012-06-20 11:55:22 +000017 Defines the LLVM intermediate representation and the assembly form of the
18 different nodes.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000019
Sean Silva258aeb52012-09-21 02:46:32 +000020* :ref:`atomics`
21
22 Information about LLVM's concurrency model.
23
Bill Wendlingaf5e2e72012-06-20 11:55:22 +000024* `The LLVM Programmers Manual <ProgrammersManual.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000025
Bill Wendlingaf5e2e72012-06-20 11:55:22 +000026 Introduction to the general layout of the LLVM sourcebase, important classes
27 and APIs, and some tips & tricks.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000028
Bill Wendling0bd3dee2012-08-08 08:21:24 +000029* :ref:`commandline`
Daniel Dunbar21e993c2012-04-19 16:31:37 +000030
Bill Wendlingaf5e2e72012-06-20 11:55:22 +000031 Provides information on using the command line parsing library.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000032
Bill Wendlingeef31a52012-06-20 11:56:24 +000033* :ref:`coding_standards`
Daniel Dunbar21e993c2012-04-19 16:31:37 +000034
Bill Wendlingaf5e2e72012-06-20 11:55:22 +000035 Details the LLVM coding standards and provides useful information on writing
36 efficient C++ code.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000037
Sean Silva36be1ae2012-10-05 03:32:01 +000038* :doc:`HowToSetUpLLVMStyleRTTI`
39
40 How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
41 class hierarchy.
42
Bill Wendlingaf5e2e72012-06-20 11:55:22 +000043* `Extending LLVM <ExtendingLLVM.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000044
Bill Wendlingaf5e2e72012-06-20 11:55:22 +000045 Look here to see how to add instructions and intrinsics to LLVM.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000046
Bill Wendlingaf5e2e72012-06-20 11:55:22 +000047* `Doxygen generated documentation <http://llvm.org/doxygen/>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000048
Bill Wendlingaf5e2e72012-06-20 11:55:22 +000049 (`classes <http://llvm.org/doxygen/inherits.html>`_)
50 (`tarball <http://llvm.org/doxygen/doxygen.tar.gz>`_)
Daniel Dunbar21e993c2012-04-19 16:31:37 +000051
Bill Wendlingaf5e2e72012-06-20 11:55:22 +000052* `ViewVC Repository Browser <http://llvm.org/viewvc/>`_
Bill Wendling53960a62012-10-07 04:34:10 +000053
54* :ref:`compiler_writer_info`
55
56 A list of helpful links for compiler writers.