Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
CommandGuide
Frontend
HistoricalNotes
PDB
Proposals
TableGen
_ocamldoc
_static
_templates
_themes/llvm-theme
tutorial Merge LLVM 325000 Jul 25, 2018
zapcc
AMDGPUUsage.rst
ARM-BE-bitcastfail.png
ARM-BE-bitcastsuccess.png
ARM-BE-ld1.png
ARM-BE-ldr.png Open Source release of zapcc! Jun 14, 2018
AdvancedBuilds.rst
AliasAnalysis.rst
Atomics.rst
Benchmarking.rst
BigEndianNEON.rst
BitCodeFormat.rst
BlockFrequencyTerminology.rst
BranchWeightMetadata.rst
Bugpoint.rst
CFIVerify.rst
CMake.rst
CMakeLists.txt
CMakePrimer.rst Merge LLVM 313000 Jul 5, 2018
CodeGenerator.rst
CodeOfConduct.rst
CodingStandards.rst Merge LLVM 325000 Jul 25, 2018
CommandLine.rst
CompileCudaWithLLVM.rst
CompilerWriterInfo.rst Merge LLVM 313000 Jul 5, 2018
Contributing.rst
Coroutines.rst
CoverageMappingFormat.rst
DebuggingJITedCode.rst
DeveloperPolicy.rst
Docker.rst 311100 Jul 3, 2018
ExceptionHandling.rst
ExtendedIntegerResults.txt
ExtendingLLVM.rst
Extensions.rst
FAQ.rst
FaultMaps.rst
FuzzingLLVM.rst
GarbageCollection.rst Open Source release of zapcc! Jun 14, 2018
GetElementPtr.rst
GettingStarted.rst Merge LLVM 325000 Jul 25, 2018
GettingStartedVS.rst
GlobalISel.rst
GoldPlugin.rst
HowToAddABuilder.rst
HowToBuildOnARM.rst
HowToCrossCompileBuiltinsOnArm.rst
HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst
HowToUseAttributes.rst
HowToUseInstrMappings.rst
InAlloca.rst
LLVMBuild.rst
LLVMBuild.txt
LangRef.rst
Lexicon.rst
LibFuzzer.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
MIRLangRef.rst
Makefile.sphinx
MarkedUpDisassembly.rst
MemorySSA.rst Merge LLVM 325000 Jul 25, 2018
MergeFunctions.rst
NVPTXUsage.rst merged with LLVM 321000 Jul 18, 2018
OptBisect.rst
Packaging.rst
Passes.rst
Phabricator.rst
ProgrammersManual.rst Merge LLVM 325000 Jul 25, 2018
Projects.rst
README.txt
ReleaseNotes.rst Merge LLVM 325000 Jul 25, 2018
ReleaseProcess.rst
ReportingGuide.rst Open Source release of zapcc! Jun 14, 2018
ScudoHardenedAllocator.rst
SegmentedStacks.rst
SourceLevelDebugging.rst
SphinxQuickstartTemplate.rst
StackMaps.rst
Statepoints.rst
SystemLibrary.rst
TableGenFundamentals.rst
TestSuiteMakefileGuide.rst
TestingGuide.rst
TypeMetadata.rst
Vectorizers.rst
WritingAnLLVMBackend.rst merged with LLVM 321000 Jul 18, 2018
WritingAnLLVMPass.rst
XRay.rst
XRayExample.rst merged with LLVM 321000 Jul 18, 2018
XRayFDRFormat.rst
YamlIO.rst merged with LLVM 321000 Jul 18, 2018
conf.py
doxygen-mainpage.dox
doxygen.cfg.in
gcc-loops.png Open Source release of zapcc! Jun 14, 2018
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 <build-dir>
    cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true <src-dir>
    make -j3 docs-llvm-html
    $BROWSER <build-dir>/docs//html/index.html

The mapping between reStructuredText files and generated documentation is
`docs/Foo.rst` <-> `<build-dir>/docs//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-dir>/docs/man/`.

    cd <build-dir>
    cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_MAN=true <src-dir>
    make -j3 docs-llvm-man
    man -l >build-dir>/docs/man/FileCheck.1

The correspondence between .rst files and man pages is
`docs/CommandGuide/Foo.rst` <-> `<build-dir>/docs//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 reachability of external links in the documentation can be checked by
running:

    cd docs/
    make -f Makefile.sphinx linkcheck

Doxygen page Output
==============

Install doxygen <http://www.stack.nl/~dimitri/doxygen/download.html> and dot2tex <https://dot2tex.readthedocs.io/en/latest>.

    cd <build-dir>
    cmake -DLLVM_ENABLE_DOXYGEN=On <llvm-top-src-dir>
    make doxygen-llvm # for LLVM docs
    make doxygen-clang # for clang docs

It will generate html in
    
    <build-dir>/docs/doxygen/html # for LLVM docs
    <build-dir>/tools/clang/docs/doxygen/html # for clang docs
You can’t perform that action at this time.