llvm/docs
2013-10-11 18:50:22 +00:00
..
_static
_templates
_themes/llvm-theme
CommandGuide Add warning about CHECK-DAG with variable definition 2013-10-11 18:50:22 +00:00
HistoricalNotes [typo] An LLVM. 2013-08-16 23:30:19 +00:00
TableGen
tutorial [docs] Fix broken link. 2013-06-21 01:11:52 +00:00
AliasAnalysis.rst
Atomics.rst Small correction to unordered memory code generation of ARM LDRD 2013-06-18 23:07:16 +00:00
BitCodeFormat.rst Implement function prefix data as an IR feature. 2013-09-16 01:08:15 +00:00
BranchWeightMetadata.rst
Bugpoint.rst
CMake.rst docs: Update old VS 2008 references. 2013-07-23 17:44:01 +00:00
CMakeLists.txt [doxygen] Use correct variable names for external variable configuration and make EXTRA_SEARCH_MAPPINGS a "dumb" variable. 2013-08-28 21:55:26 +00:00
CodeGenerator.rst Add a paragraph about MCTargetStreamer. 2013-10-09 02:05:08 +00:00
CodingStandards.rst Revert r189704, which removed the guidance about not duplicating doc comments. 2013-09-01 15:48:08 +00:00
CommandLine.rst CommandLine.rst: remove tiny bit of bad mark-up 2013-07-10 22:09:22 +00:00
CompilerWriterInfo.rst [mips] Fix a broken link to mips.com in the documentation. 2013-09-30 09:35:37 +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] Use correct variable names for external variable configuration and make EXTRA_SEARCH_MAPPINGS a "dumb" variable. 2013-08-28 21:55:26 +00:00
doxygen.css
doxygen.footer
doxygen.header
doxygen.intro
Dummy.html
ExceptionHandling.rst
ExtendedIntegerResults.txt
ExtendingLLVM.rst Fix documentation on the path to Bitcode reader/writer 2013-06-11 18:09:21 +00:00
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 Add missing releases. 2013-10-09 17:37:04 +00:00
GettingStartedVS.rst [typo] An LLVM. 2013-08-16 23:30:19 +00:00
GoldPlugin.rst Remove remaining references to -O4. 2013-09-23 19:50:59 +00:00
HowToAddABuilder.rst
HowToBuildOnARM.rst Clarifying doc about cross-compiling 2013-09-27 21:14:54 +00:00
HowToCrossCompileLLVM.rst [docs] Some typographical fixes. 2013-09-09 19:05:03 +00:00
HowToReleaseLLVM.rst
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst
HowToUseAttributes.rst
HowToUseInstrMappings.rst
index.rst [docs] Fix some Sphinx toctree warnings. 2013-09-09 19:09:00 +00:00
LangRef.rst Fix typo. 2013-10-07 13:57:59 +00:00
Lexicon.rst
LinkTimeOptimization.rst
linpack-pc.png
LLVMBuild.rst
LLVMBuild.txt
make.bat
Makefile [doxygen] Use correct variable names for external variable configuration and make EXTRA_SEARCH_MAPPINGS a "dumb" variable. 2013-08-28 21:55:26 +00:00
Makefile.sphinx
MakefileGuide.rst typo fix: use BUILD_ARCHIVE to build .a libs and not ARCHIVE_LIBRARY 2013-09-13 15:01:54 +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 Update Release Process doc 2013-06-12 11:35:33 +00:00
SegmentedStacks.rst
SourceLevelDebugging.rst Add unique identifier field to Composite Types and Format. 2013-08-29 17:07:49 +00:00
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 TableGen: Enumerate Schedule Model too. 2013-09-03 19:43:28 +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 fixes. 2013-09-12 01:43:21 +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`.