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

blob: cfb6dbeb5ede3d7f1450f387d215249d1bb46cdc [file] [log] [blame]

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