Blame - llvm/docs/programming.rst - toolchain/llvm-project

blob: aa51130533b5373bae28b6c658ca7fe6192be2b3 [file] [log] [blame]

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