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

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