NameDateSize

..10-Aug-20184 KiB

_ocamldoc/10-Aug-20184 KiB

_static/10-Aug-20184 KiB

_templates/10-Aug-20184 KiB

_themes/10-Aug-20184 KiB

AdvancedBuilds.rst10-Aug-20186.9 KiB

AliasAnalysis.rst10-Aug-201830.7 KiB

AMDGPUUsage.rst10-Aug-20186.1 KiB

ARM-BE-bitcastfail.png10-Aug-201828.7 KiB

ARM-BE-bitcastsuccess.png10-Aug-201840.5 KiB

ARM-BE-ld1.png10-Aug-201822 KiB

ARM-BE-ldr.png10-Aug-201816.1 KiB

Atomics.rst10-Aug-201827.7 KiB

BigEndianNEON.rst10-Aug-201812.2 KiB

BitCodeFormat.rst10-Aug-201838.3 KiB

BlockFrequencyTerminology.rst10-Aug-20184.6 KiB

BranchWeightMetadata.rst10-Aug-20183.7 KiB

Bugpoint.rst10-Aug-201810.4 KiB

CMake.rst10-Aug-201828.2 KiB

CMakeLists.txt10-Aug-20185.2 KiB

CMakePrimer.rst10-Aug-201815.6 KiB

CodeGenerator.rst10-Aug-2018114.3 KiB

CodeOfConduct.rst10-Aug-20185 KiB

CodingStandards.rst10-Aug-201861.3 KiB

CommandGuide/10-Aug-20184 KiB

CommandLine.rst10-Aug-201867.5 KiB

CompileCudaWithLLVM.rst10-Aug-20189.7 KiB

CompilerWriterInfo.rst10-Aug-20186.7 KiB

conf.py10-Aug-20188.3 KiB

CoverageMappingFormat.rst10-Aug-201826.3 KiB

DebuggingJITedCode.rst10-Aug-20184.9 KiB

DeveloperPolicy.rst10-Aug-201831.3 KiB

doxygen-mainpage.dox10-Aug-2018784

doxygen.cfg.in10-Aug-201898 KiB

Dummy.html10-Aug-20180

ExceptionHandling.rst10-Aug-201837.5 KiB

ExtendedIntegerResults.txt10-Aug-20184.9 KiB

ExtendingLLVM.rst10-Aug-201812.2 KiB

Extensions.rst10-Aug-20185.6 KiB

FAQ.rst10-Aug-201813.1 KiB

FaultMaps.rst10-Aug-20184.2 KiB

Frontend/10-Aug-20184 KiB

GarbageCollection.rst10-Aug-201843.7 KiB

gcc-loops.png10-Aug-201821 KiB

GetElementPtr.rst10-Aug-201822.1 KiB

GettingStarted.rst10-Aug-201846.1 KiB

GettingStartedVS.rst10-Aug-20188.5 KiB

GoldPlugin.rst10-Aug-20185.4 KiB

HistoricalNotes/10-Aug-20184 KiB

HowToAddABuilder.rst10-Aug-20183.6 KiB

HowToBuildOnARM.rst10-Aug-20183.7 KiB

HowToCrossCompileLLVM.rst10-Aug-20187.5 KiB

HowToReleaseLLVM.rst10-Aug-201816.6 KiB

HowToSetUpLLVMStyleRTTI.rst10-Aug-201813.6 KiB

HowToSubmitABug.rst10-Aug-20188.4 KiB

HowToUseAttributes.rst10-Aug-20183.5 KiB

HowToUseInstrMappings.rst10-Aug-20187.6 KiB

InAlloca.rst10-Aug-20186.3 KiB

index.rst10-Aug-201813.6 KiB

LangRef.rst10-Aug-2018441.3 KiB

Lexicon.rst10-Aug-20186.5 KiB

LibFuzzer.rst10-Aug-201836.8 KiB

LinkTimeOptimization.rst10-Aug-201810.9 KiB

linpack-pc.png10-Aug-201813.3 KiB

LLVMBuild.rst10-Aug-201812.3 KiB

LLVMBuild.txt10-Aug-2018660

make.bat10-Aug-20185 KiB

Makefile.sphinx10-Aug-20185.4 KiB

MarkedUpDisassembly.rst10-Aug-20183.3 KiB

MCJIT-creation.png10-Aug-201825.8 KiB

MCJIT-dyld-load.png10-Aug-201838 KiB

MCJIT-engine-builder.png10-Aug-201818.3 KiB

MCJIT-load-object.png10-Aug-201874.7 KiB

MCJIT-load.png10-Aug-201826.7 KiB

MCJIT-resolve-relocations.png10-Aug-201856.3 KiB

MCJITDesignAndImplementation.rst10-Aug-20188.5 KiB

MergeFunctions.rst10-Aug-201831.4 KiB

MIRLangRef.rst10-Aug-201814.3 KiB

NVPTXUsage.rst10-Aug-201829.4 KiB

Packaging.rst10-Aug-20182.6 KiB

Passes.rst10-Aug-201846.7 KiB

Phabricator.rst10-Aug-20189.6 KiB

ProgrammersManual.rst10-Aug-2018138.3 KiB

Projects.rst10-Aug-20189.4 KiB

re_format.710-Aug-201818.4 KiB

README.txt10-Aug-20182 KiB

ReleaseNotes.rst10-Aug-20186.6 KiB

ReleaseProcess.rst10-Aug-20187.3 KiB

ReportingGuide.rst10-Aug-20186.4 KiB

ScudoHardenedAllocator.rst10-Aug-20184.5 KiB

SegmentedStacks.rst10-Aug-20183.1 KiB

SourceLevelDebugging.rst10-Aug-201857.1 KiB

SphinxQuickstartTemplate.rst10-Aug-20185 KiB

StackMaps.rst10-Aug-201820.4 KiB

Statepoints.rst10-Aug-201837.3 KiB

SystemLibrary.rst10-Aug-201811.5 KiB

TableGen/10-Aug-20184 KiB

TableGenFundamentals.rst10-Aug-2018243

TestingGuide.rst10-Aug-201821.6 KiB

TestSuiteMakefileGuide.rst10-Aug-201813.3 KiB

tutorial/10-Aug-20184 KiB

TypeMetadata.rst10-Aug-20188.4 KiB

Vectorizers.rst10-Aug-201812.7 KiB

WritingAnLLVMBackend.rst10-Aug-201880.2 KiB

WritingAnLLVMPass.rst10-Aug-201859.3 KiB

yaml2obj.rst10-Aug-20189.9 KiB

YamlIO.rst10-Aug-201832.5 KiB

README.txt

1LLVM Documentation
2==================
3
4LLVM's documentation is written in reStructuredText, a lightweight
5plaintext markup language (file extension `.rst`). While the
6reStructuredText documentation should be quite readable in source form, it
7is mostly meant to be processed by the Sphinx documentation generation
8system to create HTML pages which are hosted on <http://llvm.org/docs/> and
9updated after every commit. Manpage output is also supported, see below.
10
11If you instead would like to generate and view the HTML locally, install
12Sphinx <http://sphinx-doc.org/> and then do:
13
14    cd <build-dir>
15    cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true <src-dir>
16    make -j3 docs-llvm-html
17    $BROWSER <build-dir>/docs//html/index.html
18
19The mapping between reStructuredText files and generated documentation is
20`docs/Foo.rst` <-> `<build-dir>/docs//html/Foo.html` <-> `http://llvm.org/docs/Foo.html`.
21
22If you are interested in writing new documentation, you will want to read
23`SphinxQuickstartTemplate.rst` which will get you writing documentation
24very fast and includes examples of the most important reStructuredText
25markup syntax.
26
27Manpage Output
28===============
29
30Building the manpages is similar to building the HTML documentation. The
31primary difference is to use the `man` makefile target, instead of the
32default (which is `html`). Sphinx then produces the man pages in the
33directory `<build-dir>/docs/man/`.
34
35    cd <build-dir>
36    cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_MAN=true <src-dir>
37    make -j3 docs-llvm-man
38    man -l >build-dir>/docs/man/FileCheck.1
39
40The correspondence between .rst files and man pages is
41`docs/CommandGuide/Foo.rst` <-> `<build-dir>/docs//man/Foo.1`.
42These .rst files are also included during HTML generation so they are also
43viewable online (as noted above) at e.g.
44`http://llvm.org/docs/CommandGuide/Foo.html`.
45
46Checking links
47==============
48
49The reachability of external links in the documentation can be checked by
50running:
51
52    cd docs/
53    make -f Makefile.sphinx linkcheck
54