Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: mono

This branch is 21 commits ahead, 9417 commits behind earl:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

..
Failed to load latest commit information.
CommandGuide
HistoricalNotes
TableGen
_static
_templates
_themes/llvm-theme
tutorial
ARM-BE-bitcastfail.png
ARM-BE-bitcastsuccess.png
ARM-BE-ld1.png
ARM-BE-ldr.png
AliasAnalysis.rst
Atomics.rst
BigEndianNEON.rst
BitCodeFormat.rst
BlockFrequencyTerminology.rst
BranchWeightMetadata.rst
Bugpoint.rst
CMake.rst
CMakeLists.txt
CodeGenerator.rst
CodingStandards.rst
CommandLine.rst
CompilerWriterInfo.rst
CoverageMappingFormat.rst
DebuggingJITedCode.rst
DeveloperPolicy.rst
Dummy.html
ExceptionHandling.rst
ExtendedIntegerResults.txt
ExtendingLLVM.rst
Extensions.rst
FAQ.rst
GarbageCollection.rst
GetElementPtr.rst
GettingStarted.rst
GettingStartedVS.rst
GoldPlugin.rst
HowToAddABuilder.rst
HowToBuildOnARM.rst
HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst
HowToUseAttributes.rst
HowToUseInstrMappings.rst
InAlloca.rst
LLVMBuild.rst
LLVMBuild.txt
LangRef.rst
Lexicon.rst
LinkTimeOptimization.rst
MCJIT-creation.png
MCJIT-dyld-load.png
MCJIT-engine-builder.png
MCJIT-load-object.png
MCJIT-load.png
MCJIT-resolve-relocations.png
MCJITDesignAndImplementation.rst
Makefile
Makefile.sphinx
MakefileGuide.rst
MarkedUpDisassembly.rst
NVPTXUsage.rst
Packaging.rst
Passes.rst
Phabricator.rst
ProgrammersManual.rst
Projects.rst
README.txt
ReleaseNotes.rst
ReleaseProcess.rst
SegmentedStacks.rst
SourceLevelDebugging.rst
SphinxQuickstartTemplate.rst
StackMaps.rst
SystemLibrary.rst
TableGenFundamentals.rst
TestSuiteMakefileGuide.rst
TestingGuide.rst
Vectorizers.rst
WritingAnLLVMBackend.rst
WritingAnLLVMPass.rst
YamlIO.rst
conf.py
doxygen.cfg.in
doxygen.css
doxygen.footer
doxygen.header
doxygen.intro
gcc-loops.png
index.rst
linpack-pc.png
make.bat
re_format.7
yaml2obj.rst

README.txt

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`.

Checking links
==============

The reachibility of external links in the documentation can be checked by
running:

    cd docs/
    make -f Makefile.sphinx linkcheck
Something went wrong with that request. Please try again.