llvm-6502/docs
2013-08-26 07:29:08 +00:00
..
_static
_templates
_themes/llvm-theme
CommandGuide docs: command guide: cleanups, no text changes 2013-08-18 08:32:32 +00:00
HistoricalNotes [typo] An LLVM. 2013-08-16 23:30:19 +00:00
TableGen
tutorial
AliasAnalysis.rst
Atomics.rst
BitCodeFormat.rst
BranchWeightMetadata.rst
Bugpoint.rst
CMake.rst docs: Update old VS 2008 references. 2013-07-23 17:44:01 +00:00
CMakeLists.txt [autotools->cmake] Enable generation of doxygen documentation via cmake. 2013-08-24 07:25:21 +00:00
CodeGenerator.rst Remove the mblaze backend from llvm. 2013-07-25 18:55:05 +00:00
CodingStandards.rst Add the common begin/end naming convention to the coding standard. 2013-08-07 19:34:37 +00:00
CommandLine.rst CommandLine.rst: remove tiny bit of bad mark-up 2013-07-10 22:09:22 +00:00
CompilerWriterInfo.rst R600: Add ISA documents to the CompilerWriterInfo page 2013-07-12 18:14:40 +00:00
conf.py
DebuggingJITedCode.rst
DeveloperPolicy.rst Include a clearer policy about what's ok/nok to speed up code reviews. 2013-08-26 07:29:08 +00:00
doxygen.cfg.in
doxygen.css
doxygen.footer
doxygen.header
doxygen.intro
Dummy.html
ExceptionHandling.rst
ExtendedIntegerResults.txt
ExtendingLLVM.rst
Extensions.rst Sphinx refuses to render this code block. Try adding a newline. 2013-08-14 16:18:47 +00:00
FAQ.rst
GarbageCollection.rst IR headers moved to llvm/IR some aeons ago, update documentation. 2013-07-08 19:59:35 +00:00
gcc-loops.png
GetElementPtr.rst
GettingStarted.rst [typo] An LLVM. 2013-08-16 23:30:19 +00:00
GettingStartedVS.rst [typo] An LLVM. 2013-08-16 23:30:19 +00:00
GoldPlugin.rst
HowToAddABuilder.rst
HowToBuildOnARM.rst
HowToReleaseLLVM.rst
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst
HowToUseAttributes.rst
HowToUseInstrMappings.rst
index.rst Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
LangRef.rst Add function attribute 'optnone'. 2013-08-23 11:53:55 +00:00
Lexicon.rst
LinkTimeOptimization.rst
linpack-pc.png
LLVMBuild.rst
LLVMBuild.txt
make.bat
Makefile
Makefile.sphinx
MakefileGuide.rst Remove dead code from the makefile build system. 2013-07-25 20:25:31 +00:00
MarkedUpDisassembly.rst
MCJIT-creation.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJIT-dyld-load.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJIT-engine-builder.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJIT-load-object.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJIT-load.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJIT-resolve-relocations.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJITDesignAndImplementation.rst Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
NVPTXUsage.rst
Packaging.rst
Passes.rst
Phabricator.rst Phabricator.rst: tiny fix 2013-07-25 22:58:31 +00:00
ProgrammersManual.rst IR headers moved to llvm/IR some aeons ago, update documentation. 2013-07-08 19:59:35 +00:00
Projects.rst
re_format.7
README.txt
ReleaseNotes.rst Add a release not about llvm-ar. 2013-08-06 13:16:28 +00:00
ReleaseProcess.rst
SegmentedStacks.rst
SourceLevelDebugging.rst
SphinxQuickstartTemplate.rst
SystemLibrary.rst
TableGenFundamentals.rst
TestingGuide.rst [docs] Update TestingGuide's note on how to run with Valgrind. 2013-08-09 19:39:48 +00:00
TestSuiteMakefileGuide.rst
Vectorizers.rst Update the docs. 2013-08-05 04:27:34 +00:00
WritingAnLLVMBackend.rst Revert "TableGen: Enumerate Schedule Model too." 2013-07-31 20:43:08 +00:00
WritingAnLLVMPass.rst IR headers moved to llvm/IR some aeons ago, update documentation. 2013-07-08 19:59:35 +00:00
yaml2obj.rst
YamlIO.rst [typo] An LLVM. 2013-08-16 23:30:19 +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 mostly 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. Manpage output is also supported, see below.

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.

Manpage Output
===============

Building the manpages is similar to building the HTML documentation. The
primary difference is to use the `man` makefile target, instead of the
default (which is `html`). Sphinx then produces the man pages in the
directory `_build/man/`.

    cd docs/
    make -f Makefile.sphinx man
    man -l _build/man/FileCheck.1

The correspondence between .rst files and man pages is
`docs/CommandGuide/Foo.rst` <-> `_build/man/Foo.1`.
These .rst files are also included during HTML generation so they are also
viewable online (as noted above) at e.g.
`http://llvm.org/docs/CommandGuide/Foo.html`.