llvm-mirror/docs
Sean Silva 4d52e97d28 TableGen/LangRef: discuss specific C-like escapes
Suggested by Joel Jones.

llvm-svn: 171941
2013-01-09 02:20:30 +00:00
..
_static [docs] Update HTML pages to refer to CSS in a way that works locally and with Sphinx. 2012-04-19 20:20:34 +00:00
_templates [docs] Convert docs index page into Sphinx. 2012-04-19 16:31:37 +00:00
_themes/llvm-theme Sphinx CSS: remove negative letter-spacing, it makes some fonts look really 2012-09-30 20:43:24 +00:00
CommandGuide Documentation: use paths relative to document root in links. 2012-12-12 21:16:29 +00:00
HistoricalNotes Fix a ton of comment typos found by codespell. Patch by 2011-04-15 05:18:47 +00:00
TableGen TableGen/LangRef: discuss specific C-like escapes 2013-01-09 02:20:30 +00:00
tutorial docs: Move link to the new "external tutorials" area. 2012-12-27 08:57:08 +00:00
AliasAnalysis.rst Documentation: AliasAnalysis.rst: improve internal and external links 2012-12-12 17:03:50 +00:00
Atomics.rst Fix a typo (the the => the) 2012-07-23 08:51:15 +00:00
BitCodeFormat.rst Better 80cols... *sigh* 2012-11-20 18:14:15 +00:00
BranchWeightMetadata.rst Fixed some grammar and punctuation error. 2012-12-07 19:21:10 +00:00
Bugpoint.rst Documentation: use a 'console' highlighter for terminal output examples. This 2012-12-12 14:23:14 +00:00
CMake.rst Documentation: convert WritingAnLLVMPass.html to reST. 2012-12-12 17:02:44 +00:00
CodeGenerator.rst Documentation: convert ReleaseNotes.html to reST. 2012-12-09 23:14:26 +00:00
CodingStandards.rst Simplify the coding standards for #include ordering. The ordering is now 2012-12-02 11:53:27 +00:00
CommandLine.rst Sphinxify the CommandLine document. 2012-08-08 08:21:24 +00:00
CompilerWriterInfo.rst Documentation: CompilerWriterInfo.rst: update link to Intel documentation 2012-12-13 20:02:11 +00:00
conf.py Update the copyright coredits -- Happy new year 2013! 2013-01-01 10:00:19 +00:00
DebuggingJITedCode.rst Fix Sphinx warnings. 2012-09-20 03:20:53 +00:00
design_and_overview.rst Documentation: add a missing space 2012-12-19 12:51:48 +00:00
DeveloperPolicy.rst Documentation: convert ReleaseNotes.html to reST. 2012-12-09 23:14:26 +00:00
development_process.rst Convert HowToReleaseLLVM.html to reST 2012-12-07 16:42:48 +00:00
doxygen.cfg.in Reapply r141657. 2011-10-31 23:46:50 +00:00
doxygen.css [docs] Update Makefile for images removal. 2012-04-20 17:27:12 +00:00
doxygen.footer Update the copyright coredits -- Happy new year 2013! 2013-01-01 10:00:19 +00:00
doxygen.header Tidy up. s/Low Level Virtual Machine/LLVM/. 2012-01-25 22:00:23 +00:00
doxygen.intro Tidy up. s/Low Level Virtual Machine/LLVM/. 2012-01-25 22:00:23 +00:00
Dummy.html Add a dummy documentation file to unbreak 'make install'. We need to find how 2012-12-13 13:37:35 +00:00
ExceptionHandling.rst Sphinxify the exception handling doc. 2012-06-27 07:20:57 +00:00
ExtendedIntegerResults.txt Revert r103213. It broke several sections of live website. 2010-05-07 00:28:04 +00:00
ExtendingLLVM.rst docs: Propagate fix from r165632 to other docs. 2012-10-10 17:21:39 +00:00
FAQ.rst docs: Add FAQ about "storing to a virtual register". 2012-12-27 10:23:04 +00:00
GarbageCollection.rst Documentation: convert WritingAnLLVMPass.html to reST. 2012-12-12 17:02:44 +00:00
gcc-loops.png Update the gcc-loops benchmarks results with the new automatic unrolling feature. 2013-01-04 19:10:34 +00:00
GetElementPtr.rst Documentation: fix typos and formatting. 2012-12-06 21:12:35 +00:00
GettingStarted.rst Documentation: add a note that Clang on Mageia 2 can not find libstdc++ headers 2013-01-07 12:17:44 +00:00
GettingStartedVS.rst Fix a typo (the the => the) 2012-07-23 08:51:15 +00:00
GoldPlugin.rst GoldPlugin.rst: minor typesetting fixes. 2012-10-05 20:50:05 +00:00
HowToAddABuilder.rst Patch by Sean Silva! 2012-09-13 23:51:08 +00:00
HowToBuildOnARM.rst Minor enhancement to build process notes for ARM platforms. 2012-10-26 12:09:47 +00:00
HowToReleaseLLVM.rst Documentation: HowToReleaseLLVM.rst: remove trailing whitespace. 2012-12-09 15:33:26 +00:00
HowToSetUpLLVMStyleRTTI.rst docs: Update example to conform to coding standards. 2012-10-12 01:55:51 +00:00
HowToSubmitABug.rst docs: Sphinxify HowToSubmitABug 2012-09-25 20:52:04 +00:00
HowToUseInstrMappings.rst Fix typo. 2012-11-15 21:21:01 +00:00
index.rst docs: Fix typo on front page 2012-10-04 04:41:27 +00:00
LangRef.rst Add a new attribute, 'noduplicate'. If a function contains a noduplicate call, the call cannot be duplicated - Jump threading, loop unrolling, loop unswitching, and loop rotation are inhibited if they would duplicate the call. 2012-12-20 16:04:27 +00:00
Lexicon.rst Documentation: Lexicon.rst: add 'SLP' acronym 2012-12-11 23:13:23 +00:00
LinkTimeOptimization.rst Documentation: cleanup 2012-12-12 16:58:13 +00:00
linpack-pc.png Add linpack-pc bench 2013-01-04 19:00:42 +00:00
LLVMBuild.rst docs: Sphinxify LLVMBuild documentation. 2012-11-20 03:13:53 +00:00
LLVMBuild.txt LLVMBuild: Remove trailing newline, which irked me. 2011-12-12 19:48:00 +00:00
mailing_lists.rst [docs] Convert docs index page into Sphinx. 2012-04-19 16:31:37 +00:00
make.bat [docs] Stub out structure for Sphinx-based docs. 2012-04-19 16:31:19 +00:00
Makefile [docs] Remove POD based man page docs (and build system support). 2012-05-08 17:48:21 +00:00
Makefile.sphinx Makefile.sphinx: reST conversion is complete! 2012-12-12 21:35:43 +00:00
MakefileGuide.rst Documentation: fix typos reported in PR13866 2012-12-23 18:46:11 +00:00
MarkedUpDisassembly.rst Add a bit of documentation on the annotated disassembly output. 2012-10-24 23:30:22 +00:00
Packaging.rst Sphinxify the outdated Packaging documentation. 2012-06-21 06:09:37 +00:00
Passes.rst Documentation: convert Passes.html to reST. 2012-12-11 15:29:37 +00:00
Phabricator.rst docs: use code font for console commands in phabricator manual 2012-11-06 15:04:37 +00:00
ProgrammersManual.rst docs: Fix broken link. 2012-12-04 03:45:27 +00:00
programming.rst docs: Convert ProgrammersManual to reST. 2012-12-04 03:20:08 +00:00
Projects.rst docs: Sphinxify TestingGuide 2012-11-14 21:09:30 +00:00
re_format.7 Revert r103213. It broke several sections of live website. 2010-05-07 00:28:04 +00:00
README.txt docs: update docs/README.txt and make it useful. 2013-01-02 02:31:51 +00:00
ReleaseNotes.rst Actually update the grammar of this sentence to reflect the removal of CellSPU. 2012-12-15 08:56:20 +00:00
SegmentedStacks.rst Sphinxify the SegmentedStack document. 2012-06-20 12:05:05 +00:00
SourceLevelDebugging.rst Remove the llvm-local DW_TAG_vector_type tag and add a test to 2013-01-08 01:53:52 +00:00
SphinxQuickstartTemplate.rst docs: Improve discussion of syntax highlighting. 2012-12-13 20:14:25 +00:00
subsystems.rst tblgen, docs: Add initial syntax reference. 2013-01-07 02:43:44 +00:00
SystemLibrary.rst Documentation: improve formatting and remove unneeded empty lines. 2012-11-28 21:40:54 +00:00
TableGenFundamentals.rst fix a couple of typos 2013-01-04 19:09:15 +00:00
TestingGuide.rst Documentation: add a section to prevent spurious test failures like the one 2012-12-30 14:51:03 +00:00
TestSuiteMakefileGuide.rst docs: Sphinxify TestSuiteMakefileGuide 2012-11-14 23:11:10 +00:00
userguides.rst Initial implementation of a utility for converting native data 2012-12-12 20:46:15 +00:00
Vectorizers.rst Docs: mention that we support float reductions when -ffast-math is used. 2013-01-08 17:46:30 +00:00
WritingAnLLVMBackend.rst docs: Fix FIXME 2012-12-31 11:49:51 +00:00
WritingAnLLVMPass.rst Documentation: convert WritingAnLLVMPass.html to reST. 2012-12-12 17:02:44 +00:00
yaml2obj.rst docs: Fix long-standing typo in yaml2obj.rst. 2012-09-21 19:48:16 +00:00
YamlIO.rst Initial implementation of a utility for converting native data 2012-12-12 20:46:15 +00:00

LLVM Documentation
==================

LLVM's documentation is written in reStructuredText, a lightweight
plaintext markup language (file extension `.rst`). While the
reStructuredText documentation should be quite readable in source form, it
is meant to be processed by the Sphinx documentation generation system to
create HTML pages which are hosted on <http://llvm.org/docs/> and updated
after every commit.

If you instead would like to generate and view the HTML locally, install
Sphinx <http://sphinx-doc.org/> and then do:

    cd docs/
    make -f Makefile.sphinx
    $BROWSER _build/html/index.html

The mapping between reStructuredText files and generated documentation is
`docs/Foo.rst` <-> `_build/html/Foo.html` <-> `http://llvm.org/docs/Foo.html`.

If you are interested in writing new documentation, you will want to read
`SphinxQuickstartTemplate.rst` which will get you writing documentation
very fast and includes examples of the most important reStructuredText
markup syntax.