Blame - docs/programming.rst - platform/external/llvm

blob: c4eec59417e88ed2d7dab7aa7ec43999cf011d5e [file] [log] [blame]

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