• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..--

CommandGuide/22-Nov-2023-3,6542,236

HistoricalNotes/22-Nov-2023-2,3141,775

TableGen/22-Nov-2023-1,7661,297

_static/22-Nov-2023-11391

_templates/22-Nov-2023-2216

_themes/llvm-theme/22-Nov-2023-401331

tutorial/22-Nov-2023-12,55410,096

ARM-BE-bitcastfail.pngD22-Nov-202328.7 KiB

ARM-BE-bitcastsuccess.pngD22-Nov-202340.5 KiB

ARM-BE-ld1.pngD22-Nov-202322 KiB

ARM-BE-ldr.pngD22-Nov-202316.1 KiB

AliasAnalysis.rstD22-Nov-202330.9 KiB714545

Atomics.rstD22-Nov-202319.2 KiB438345

BigEndianNEON.rstD22-Nov-202312.2 KiB206126

BitCodeFormat.rstD22-Nov-202336.8 KiB1,111778

BlockFrequencyTerminology.rstD22-Nov-20234.6 KiB13194

BranchWeightMetadata.rstD22-Nov-20232.9 KiB11883

Bugpoint.rstD22-Nov-202310.4 KiB217172

CMake.rstD22-Nov-202318.2 KiB502365

CMakeLists.txtD22-Nov-20233.5 KiB10791

CodeGenerator.rstD22-Nov-2023105.7 KiB2,4451,928

CodingStandards.rstD22-Nov-202361 KiB1,6201,232

CommandLine.rstD22-Nov-202367.4 KiB1,7441,291

CompilerWriterInfo.rstD22-Nov-20236.3 KiB163106

DebuggingJITedCode.rstD22-Nov-20234.9 KiB144123

DeveloperPolicy.rstD22-Nov-202325.9 KiB547422

Dummy.htmlD22-Nov-20230 10

ExceptionHandling.rstD22-Nov-202318.2 KiB423319

ExtendedIntegerResults.txtD22-Nov-20234.9 KiB134107

ExtendingLLVM.rstD22-Nov-202311.5 KiB305203

Extensions.rstD22-Nov-20235 KiB212146

FAQ.rstD22-Nov-202318.2 KiB478351

GarbageCollection.rstD22-Nov-202339.2 KiB1,015755

GetElementPtr.rstD22-Nov-202321.9 KiB537395

GettingStarted.rstD22-Nov-202348.3 KiB1,337945

GettingStartedVS.rstD22-Nov-20238.2 KiB235162

GoldPlugin.rstD22-Nov-20235.3 KiB173124

HowToAddABuilder.rstD22-Nov-20233.6 KiB8764

HowToBuildOnARM.rstD22-Nov-20232.9 KiB7053

HowToCrossCompileLLVM.rstD22-Nov-20236.1 KiB176126

HowToReleaseLLVM.rstD22-Nov-202318.4 KiB442323

HowToSetUpLLVMStyleRTTI.rstD22-Nov-202312.9 KiB401319

HowToSubmitABug.rstD22-Nov-20238.4 KiB230165

HowToUseAttributes.rstD22-Nov-20233.5 KiB8262

HowToUseInstrMappings.rstD22-Nov-20237.6 KiB176145

InAlloca.rstD22-Nov-20236.3 KiB161130

LLVMBuild.rstD22-Nov-202312.3 KiB326228

LLVMBuild.txtD22-Nov-2023660 2220

LangRef.rstD22-Nov-2023314.1 KiB9,3276,911

Lexicon.rstD22-Nov-20235.2 KiB223160

LinkTimeOptimization.rstD22-Nov-202311 KiB300217

MCJIT-creation.pngD22-Nov-202325.8 KiB

MCJIT-dyld-load.pngD22-Nov-202338 KiB

MCJIT-engine-builder.pngD22-Nov-202318.3 KiB

MCJIT-load-object.pngD22-Nov-202374.7 KiB

MCJIT-load.pngD22-Nov-202326.7 KiB

MCJIT-resolve-relocations.pngD22-Nov-202356.3 KiB

MCJITDesignAndImplementation.rstD22-Nov-20238.6 KiB181144

MakefileD22-Nov-20234.3 KiB12997

Makefile.sphinxD22-Nov-20235.4 KiB156125

MakefileGuide.rstD22-Nov-202333.1 KiB917707

MarkedUpDisassembly.rstD22-Nov-20233.3 KiB8760

NVPTXUsage.rstD22-Nov-202329.4 KiB981714

Packaging.rstD22-Nov-20232.6 KiB7456

Passes.rstD22-Nov-202347.6 KiB1,194864

Phabricator.rstD22-Nov-20235 KiB140101

ProgrammersManual.rstD22-Nov-2023127 KiB3,2682,380

Projects.rstD22-Nov-20239.4 KiB258180

README.txtD22-Nov-20231.8 KiB5239

ReleaseNotes.rstD22-Nov-20235.7 KiB137102

ReleaseProcess.rstD22-Nov-20237.3 KiB211139

SegmentedStacks.rstD22-Nov-20233.1 KiB7860

SourceLevelDebugging.rstD22-Nov-202383.5 KiB2,3221,904

SphinxQuickstartTemplate.rstD22-Nov-20235 KiB161111

StackMaps.rstD22-Nov-202319.9 KiB497402

SystemLibrary.rstD22-Nov-202311.5 KiB248197

TableGenFundamentals.rstD22-Nov-2023243 118

TestSuiteMakefileGuide.rstD22-Nov-202311.1 KiB277209

TestingGuide.rstD22-Nov-202319 KiB530378

Vectorizers.rstD22-Nov-202312.7 KiB427303

WritingAnLLVMBackend.rstD22-Nov-202380.4 KiB1,9421,530

WritingAnLLVMPass.rstD22-Nov-202359 KiB1,4361,090

YamlIO.rstD22-Nov-202329.9 KiB952719

conf.pyD22-Nov-20238.2 KiB25352

doxygen.cfg.inD22-Nov-202367.1 KiB1,6421,179

doxygen.cssD22-Nov-20239 KiB409401

doxygen.footerD22-Nov-2023378 1411

doxygen.headerD22-Nov-2023471 109

doxygen.introD22-Nov-2023787 1918

gcc-loops.pngD22-Nov-202321 KiB

index.rstD22-Nov-202312.2 KiB443320

linpack-pc.pngD22-Nov-202313.3 KiB

make.batD22-Nov-20235 KiB191167

re_format.7D22-Nov-202318.4 KiB757756

yaml2obj.rstD22-Nov-20239.8 KiB221205

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 docs/
15    make -f Makefile.sphinx
16    $BROWSER _build/html/index.html
17
18The mapping between reStructuredText files and generated documentation is
19`docs/Foo.rst` <-> `_build/html/Foo.html` <-> `http://llvm.org/docs/Foo.html`.
20
21If you are interested in writing new documentation, you will want to read
22`SphinxQuickstartTemplate.rst` which will get you writing documentation
23very fast and includes examples of the most important reStructuredText
24markup syntax.
25
26Manpage Output
27===============
28
29Building the manpages is similar to building the HTML documentation. The
30primary difference is to use the `man` makefile target, instead of the
31default (which is `html`). Sphinx then produces the man pages in the
32directory `_build/man/`.
33
34    cd docs/
35    make -f Makefile.sphinx man
36    man -l _build/man/FileCheck.1
37
38The correspondence between .rst files and man pages is
39`docs/CommandGuide/Foo.rst` <-> `_build/man/Foo.1`.
40These .rst files are also included during HTML generation so they are also
41viewable online (as noted above) at e.g.
42`http://llvm.org/docs/CommandGuide/Foo.html`.
43
44Checking links
45==============
46
47The reachibility of external links in the documentation can be checked by
48running:
49
50    cd docs/
51    make -f Makefile.sphinx linkcheck
52