llvm-project/llvm/docs/programming.rst

.. _programming:

Programming Documentation
=========================

.. toctree::
   :hidden:

   CodingStandards
   CommandLine
   Atomics

* `LLVM Language Reference Manual <LangRef.html>`_

  Defines the LLVM intermediate representation and the assembly form of the
  different nodes.

* :ref:`atomics`

  Information about LLVM's concurrency model.

* `The LLVM Programmers Manual <ProgrammersManual.html>`_

  Introduction to the general layout of the LLVM sourcebase, important classes
  and APIs, and some tips & tricks.

* :ref:`commandline`

  Provides information on using the command line parsing library.

* :ref:`coding_standards`

  Details the LLVM coding standards and provides useful information on writing
  efficient C++ code.

* `Extending LLVM <ExtendingLLVM.html>`_

  Look here to see how to add instructions and intrinsics to LLVM.

* `Doxygen generated documentation <http://llvm.org/doxygen/>`_

  (`classes <http://llvm.org/doxygen/inherits.html>`_)
  (`tarball <http://llvm.org/doxygen/doxygen.tar.gz>`_)

* `ViewVC Repository Browser <http://llvm.org/viewvc/>`_
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00			`.. _programming:`

			`Programming Documentation`
			`=========================`

Move coding standards reference from development_process.rst to programming.rst. llvm-svn: 158818 2012-06-20 19:56:24 +08:00			`.. toctree::`
			`:hidden:`

			`CodingStandards`
Sphinxify the CommandLine document. llvm-svn: 161479 2012-08-08 16:21:24 +08:00			`CommandLine`
docs: Fix Sphinx warning over Atomics.rst. Atomics.rst was not linked into the toctree. Docs now build warning-free! llvm-svn: 164356 2012-09-21 10:46:32 +08:00			`Atomics`
Move coding standards reference from development_process.rst to programming.rst. llvm-svn: 158818 2012-06-20 19:56:24 +08:00
Unindent list. llvm-svn: 158817 2012-06-20 19:55:22 +08:00			* `LLVM Language Reference Manual <LangRef.html>`_
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158817 2012-06-20 19:55:22 +08:00			`Defines the LLVM intermediate representation and the assembly form of the`
			`different nodes.`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
docs: Fix Sphinx warning over Atomics.rst. Atomics.rst was not linked into the toctree. Docs now build warning-free! llvm-svn: 164356 2012-09-21 10:46:32 +08:00			* :ref:`atomics`

			`Information about LLVM's concurrency model.`

Unindent list. llvm-svn: 158817 2012-06-20 19:55:22 +08:00			* `The LLVM Programmers Manual <ProgrammersManual.html>`_
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158817 2012-06-20 19:55:22 +08:00			`Introduction to the general layout of the LLVM sourcebase, important classes`
			`and APIs, and some tips & tricks.`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Sphinxify the CommandLine document. llvm-svn: 161479 2012-08-08 16:21:24 +08:00			* :ref:`commandline`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158817 2012-06-20 19:55:22 +08:00			`Provides information on using the command line parsing library.`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Move coding standards reference from development_process.rst to programming.rst. llvm-svn: 158818 2012-06-20 19:56:24 +08:00			* :ref:`coding_standards`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158817 2012-06-20 19:55:22 +08:00			`Details the LLVM coding standards and provides useful information on writing`
			`efficient C++ code.`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158817 2012-06-20 19:55:22 +08:00			* `Extending LLVM <ExtendingLLVM.html>`_
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158817 2012-06-20 19:55:22 +08:00			`Look here to see how to add instructions and intrinsics to LLVM.`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158817 2012-06-20 19:55:22 +08:00			* `Doxygen generated documentation <http://llvm.org/doxygen/>`_
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158817 2012-06-20 19:55:22 +08:00			(`classes <http://llvm.org/doxygen/inherits.html>`_)
			(`tarball <http://llvm.org/doxygen/doxygen.tar.gz>`_)
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158817 2012-06-20 19:55:22 +08:00			* `ViewVC Repository Browser <http://llvm.org/viewvc/>`_