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

blob: 56eaf0886c8f4e89a49ec64978862dda2a7bddbd [file] [log] [blame]

Micah Villmow	593c0b0	2012-09-27 17:51:02 +0000	[diff] [blame]	1	.. _userguides:
				2
				3	User Guides
				4	===========
				5
				6	.. toctree::
				7	:hidden:
				8
				9	CMake
				10	HowToBuildOnARM
				11	CommandGuide/index
				12	DeveloperPolicy
Bill Wendling	f93c55a	2012-10-07 07:10:13 +0000	[diff] [blame]	13	GettingStarted
Micah Villmow	593c0b0	2012-09-27 17:51:02 +0000	[diff] [blame]	14	GettingStartedVS
				15	FAQ
				16	Lexicon
				17	Packaging
				18	HowToAddABuilder
				19	yaml2obj
Sean Silva	87ed553	2012-09-25 20:52:04 +0000	[diff] [blame]	20	HowToSubmitABug
Sean Silva	5d499c2	2012-10-12 00:53:48 +0000	[diff] [blame]	21	SphinxQuickstartTemplate
Sean Silva	b92dfe0	2012-10-12 01:21:24 +0000	[diff] [blame]	22	Phabricator
Sean Silva	ac99eed	2012-11-14 21:09:30 +0000	[diff] [blame]	23	TestingGuide
Sean Silva	91b9763	2012-12-04 21:16:41 +0000	[diff] [blame]	24	tutorial/index
Dmitri Gribenko	e17d858	2012-12-09 23:14:26 +0000	[diff] [blame]	25	ReleaseNotes
Dmitri Gribenko	b64f020	2012-12-12 17:02:44 +0000	[diff] [blame]	26	Passes
Micah Villmow	593c0b0	2012-09-27 17:51:02 +0000	[diff] [blame]	27
Bill Wendling	f93c55a	2012-10-07 07:10:13 +0000	[diff] [blame]	28	* :ref:`getting_started`
Micah Villmow	593c0b0	2012-09-27 17:51:02 +0000	[diff] [blame]	29
				30	Discusses how to get up and running quickly with the LLVM infrastructure.
				31	Everything from unpacking and compilation of the distribution to execution
				32	of some tools.
				33
				34	* :ref:`building-with-cmake`
				35
				36	An addendum to the main Getting Started guide for those using the `CMake
				37	build system <http://www.cmake.org>`_.
				38
				39	* :ref:`how_to_build_on_arm`
				40
				41	Notes on building and testing LLVM/Clang on ARM.
				42
Sean Silva	1693583	2012-12-04 21:16:34 +0000	[diff] [blame]	43	* :doc:`GettingStartedVS`
Micah Villmow	593c0b0	2012-09-27 17:51:02 +0000	[diff] [blame]	44
				45	An addendum to the main Getting Started guide for those using Visual Studio
				46	on Windows.
				47
Sean Silva	91b9763	2012-12-04 21:16:41 +0000	[diff] [blame]	48	* :doc:`tutorial/index`
Micah Villmow	593c0b0	2012-09-27 17:51:02 +0000	[diff] [blame]	49
				50	A walk through the process of using LLVM for a custom language, and the
				51	facilities LLVM offers in tutorial form.
				52
				53	* :ref:`developer_policy`
				54
				55	The LLVM project's policy towards developers and their contributions.
				56
				57	* :ref:`LLVM Command Guide <commands>`
				58
				59	A reference manual for the LLVM command line utilities ("man" pages for LLVM
				60	tools).
				61
Dmitri Gribenko	b64f020	2012-12-12 17:02:44 +0000	[diff] [blame]	62	* :doc:`Passes`
Micah Villmow	593c0b0	2012-09-27 17:51:02 +0000	[diff] [blame]	63
				64	A list of optimizations and analyses implemented in LLVM.
Dmitri Gribenko	b64f020	2012-12-12 17:02:44 +0000	[diff] [blame]	65
Micah Villmow	593c0b0	2012-09-27 17:51:02 +0000	[diff] [blame]	66	* :ref:`faq`
				67
				68	A list of common questions and problems and their solutions.
				69
Dmitri Gribenko	e17d858	2012-12-09 23:14:26 +0000	[diff] [blame]	70	* :doc:`Release notes for the current release <ReleaseNotes>`
Micah Villmow	593c0b0	2012-09-27 17:51:02 +0000	[diff] [blame]	71
				72	This describes new features, known bugs, and other limitations.
				73
Sean Silva	87ed553	2012-09-25 20:52:04 +0000	[diff] [blame]	74	* :ref:`how-to-submit-a-bug-report`
Micah Villmow	593c0b0	2012-09-27 17:51:02 +0000	[diff] [blame]	75
				76	Instructions for properly submitting information about any bugs you run into
				77	in the LLVM system.
Sean Silva	5d499c2	2012-10-12 00:53:48 +0000	[diff] [blame]	78	* :doc:`SphinxQuickstartTemplate`
				79
				80	A template + tutorial for writing new Sphinx documentation. It is meant
				81	to be read in source form.
Micah Villmow	593c0b0	2012-09-27 17:51:02 +0000	[diff] [blame]	82
Sean Silva	ac99eed	2012-11-14 21:09:30 +0000	[diff] [blame]	83	* :doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
Micah Villmow	593c0b0	2012-09-27 17:51:02 +0000	[diff] [blame]	84
				85	A reference manual for using the LLVM testing infrastructure.
				86
				87	* `How to build the C, C++, ObjC, and ObjC++ front end <http://clang.llvm.org/get_started.html>`_
				88
				89	Instructions for building the clang front-end from source.
				90
				91	* :ref:`packaging`
				92
				93	Advice on packaging LLVM into a distribution.
				94
				95	* :ref:`lexicon`
				96
				97	Definition of acronyms, terms and concepts used in LLVM.
				98
				99	* :ref:`how_to_add_a_builder`
				100
				101	Instructions for adding new builder to LLVM buildbot master.
				102
				103	* IRC -- You can probably find help on the unofficial LLVM IRC.
				104
				105	We often are on irc.oftc.net in the #llvm channel. If you are using the
				106	mozilla browser, and have chatzilla installed, you can `join #llvm on
				107	irc.oftc.net <irc://irc.oftc.net/llvm>`_.