maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/llvm/docs/programming.rst

57 lines
1.3 KiB
ReStructuredText
Raw Normal View History

[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
Sphinxify the compiler writer info documentation. llvm-svn: 165369
2012-10-07 12:34:10 +08:00
CompilerWriterInfo
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
docs: Add HowToSetUpLLVMStyleRTTI.rst. This document describes how to set up LLVM-style RTTI for a class hierarchy. Surprisingly, this was not previously documented. Also, link it into ProgrammersManual.html. llvm-svn: 165293
2012-10-05 11:32:01 +08:00
HowToSetUpLLVMStyleRTTI
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
docs: Add HowToSetUpLLVMStyleRTTI.rst. This document describes how to set up LLVM-style RTTI for a class hierarchy. Surprisingly, this was not previously documented. Also, link it into ProgrammersManual.html. llvm-svn: 165293
2012-10-05 11:32:01 +08:00
* :doc:`HowToSetUpLLVMStyleRTTI`
How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
class hierarchy.
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/>`_
Sphinxify the compiler writer info documentation. llvm-svn: 165369
2012-10-07 12:34:10 +08:00
* :ref:`compiler_writer_info`
A list of helpful links for compiler writers.