llvm-project/llvm/docs
Lang Hames ad92f16ccc [ORC][examples] Update Kaleidoscope and BuildingAJIT tutorial series to OrcV2.
This patch updates the Kaleidoscope and BuildingAJIT tutorial series (chapter
1-4) to OrcV2. Chapter 5 of the BuildingAJIT series is removed -- it will be
re-instated once we have in-tree support for out-of-process JITing.

This patch only updates the tutorial code, not the text. Patches welcome for
that, otherwise I will try to update it in a few weeks.
2020-10-18 21:03:04 -07:00
..
AMDGPU [AMDGPU][MC][NFC][DOC] Updated AMD GPU assembler syntax description. 2020-08-21 14:25:14 +03:00
CommandGuide [llvm-objdump] Implement --prefix option 2020-10-16 17:50:42 +01:00
DependenceGraphs [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
Frontend update of the llvm doc: we moved to git 2020-03-22 22:36:21 +01:00
GlobalISel [GlobalISel] Add G_VECREDUCE_* opcodes for vector reductions. 2020-10-08 10:33:19 -07:00
HistoricalNotes Doc: Links should use https 2020-03-22 22:49:33 +01:00
PDB Fix a few spellos in docs. 2019-09-13 14:58:24 +00:00
Proposals [VPlan] Disconnect VPValue and VPUser. 2020-09-23 14:44:31 +01:00
TableGen [TableGen] Change Programmer's Reference to use "DAG argument" rather than "operand". 2020-10-18 10:50:14 -04:00
_ocamldoc
_static
_templates [www] More HTTPS and outdated link fixes. 2019-11-08 14:41:27 -08:00
_themes/llvm-theme [Docs] Updates sidebar links and sets max-width property for div.body 2019-10-15 21:27:20 +00:00
tutorial [ORC][examples] Update Kaleidoscope and BuildingAJIT tutorial series to OrcV2. 2020-10-18 21:03:04 -07:00
AMDGPUDwarfExtensionsForHeterogeneousDebugging.rst [docs] Fix typos 2020-09-11 17:58:07 +02:00
AMDGPUInstructionNotation.rst [AMDGPU][MC][NFC][DOC] Updated AMD GPU assembler syntax description. 2020-08-21 14:25:14 +03:00
AMDGPUInstructionSyntax.rst [AMDGPU][MC][NFC][DOC] Updated AMD GPU assembler syntax description. 2020-08-21 14:25:14 +03:00
AMDGPUModifierSyntax.rst [AMDGPU][MC][NFC][DOC] Updated AMD GPU assembler syntax description. 2020-08-21 14:25:14 +03:00
AMDGPUOperandSyntax.rst [AMDGPU][MC][NFC][DOC] Updated AMD GPU assembler syntax description. 2020-08-21 14:25:14 +03:00
AMDGPUUsage.rst [AMDGPU] Fix gfx1032 description in AMDGPUUsage.rst. NFC. 2020-10-16 13:29:20 -07:00
ARM-BE-bitcastfail.png
ARM-BE-bitcastsuccess.png
ARM-BE-ld1.png
ARM-BE-ldr.png
AddingConstrainedIntrinsics.rst [FEnv] Fix AddingConstrainedIntrinsics.rst after llvmorg-10-init-10282-g0c50c0b0552 2019-11-19 23:09:13 -08:00
AdvancedBuilds.rst Update documentation and implementation of stage3 build 2020-10-08 07:55:37 +02:00
AliasAnalysis.rst [docs] Fix typos 2020-08-09 19:31:49 -07:00
Atomics.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
Benchmarking.rst
BigEndianNEON.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
BitCodeFormat.rst [LangRef] Introduce `noundef` attribute for fully defined function params 2020-07-08 19:02:04 +00:00
BlockFrequencyTerminology.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
BranchWeightMetadata.rst Add support of __builtin_expect_with_probability 2020-06-22 10:21:28 -07:00
BugLifeCycle.rst [docs] Fix typos 2020-08-09 19:31:49 -07:00
Bugpoint.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
BugpointRedesign.md [Bugpoint redesign] Fix nonlocal URI link in doc 2019-08-09 21:48:47 +00:00
BuildingADistribution.rst Remove AllTargetsAsmPrinters 2020-01-17 19:04:06 -05:00
CFIVerify.rst
CMake.rst [docs] Document LLVM_EXTERNALIZE_DEBUGINFO CMake option 2020-09-13 21:39:27 -07:00
CMakeLists.txt
CMakePrimer.rst [CMake] Bump CMake minimum version to 3.13.4 2020-07-22 14:25:07 -04:00
CodeGenerator.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
CodeOfConduct.rst
CodeReview.rst High-Level Code-Review Documentation Update 2020-03-07 04:20:18 +00:00
CodingStandards.rst [doc] Describe the header guard style 2020-07-30 16:08:07 -07:00
CommandLine.rst [ConstProp] Remove ConstantPropagation 2020-08-26 15:51:30 -07:00
CompileCudaWithLLVM.rst doc: use the right url to bugzilla 2020-03-22 22:49:40 +01:00
CompilerWriterInfo.rst [CSKY 1/n] Add basic stub or infra of csky backend 2020-10-10 10:44:08 +08:00
Contributing.rst [docs] LLVM Security Group and Process 2020-07-10 15:24:02 -07:00
Coroutines.rst [Coroutines] Fix a typo in documentation 2020-09-14 18:56:57 -07:00
CoverageMappingFormat.rst Reland: [Coverage] Revise format to reduce binary size 2020-02-28 18:12:04 -08:00
DebuggingJITedCode.rst [docs] Fix references to a renamed flag. 2019-11-06 14:42:57 -08:00
DeveloperPolicy.rst We don't need two different ways to get commit access, just simplify 2020-09-30 22:36:44 -07:00
Docker.rst update of the llvm doc: we moved to git 2020-03-22 22:36:21 +01:00
ExceptionHandling.rst [docs] Fix typos 2020-08-09 19:31:49 -07:00
ExtendedIntegerResults.txt
ExtendingLLVM.rst [docs] Update ExtendingLLVM.rst 2020-09-21 16:49:48 -07:00
Extensions.rst Introduce and use a new section type for the bb_addr_map section. 2020-10-08 11:13:19 -07:00
FAQ.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
FaultMaps.rst
FuzzingLLVM.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
GarbageCollection.rst [AsmPrinter] De-capitalize all AsmPrinter::Emit* but EmitInstruction 2020-02-13 17:06:24 -08:00
GetElementPtr.rst [DOC] Fix `load` instructions' syntax, function definition. 2019-06-12 11:24:22 +00:00
GettingInvolved.rst Add the CodeReview Documentation to GettingInvolved TOC 2020-03-07 04:55:46 +00:00
GettingStarted.rst [NFC][docs] Fix link. 2020-09-22 23:40:03 +00:00
GettingStartedTutorials.rst [Docs] Adds Documentation links to sidebar 2019-10-09 20:26:13 +00:00
GettingStartedVS.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
GitBisecting.rst git bisect docs: formatting tweaks 2020-02-10 15:47:59 -05:00
GoldPlugin.rst
GwpAsan.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
HowToAddABuilder.rst [docs/examples] As part of using inclusive language within the llvm 2020-06-20 00:51:18 -07:00
HowToBuildOnARM.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
HowToBuildWithPGO.rst [docs] NFC: Fix typos in documents 2020-01-07 16:06:14 +01:00
HowToCrossCompileBuiltinsOnArm.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
HowToCrossCompileLLVM.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
HowToReleaseLLVM.rst Remove some autoconf references from docs and comments 2019-07-03 09:57:59 +00:00
HowToSetUpLLVMStyleRTTI.rst [docs] Fix typos 2020-08-09 19:31:49 -07:00
HowToSubmitABug.rst [docs] LLVM Security Group and Process 2020-07-10 15:24:02 -07:00
HowToUpdateDebugInfo.rst [docs] Recommend dropLocation() over setDebugLoc(DebugLoc()) 2020-09-29 17:07:14 -07:00
HowToUseAttributes.rst Remove references to the 4.0 release as a major breaking (NFC) 2020-06-25 23:49:07 +00:00
HowToUseInstrMappings.rst [llvm] NFC: Fix trivial typo in rst and td files 2020-04-23 14:26:32 +09:00
InAlloca.rst
LLVMBuild.rst
LLVMBuild.txt Doc: Links should use https 2020-03-22 22:49:33 +01:00
LangRef.rst Add support for !noundef metatdata on loads 2020-10-17 13:50:10 +09:00
Lexicon.rst [analyzer][docs][NFC] Document the ento namespace in the llvm/Lexicon 2020-09-14 08:43:56 +02:00
LibFuzzer.rst Revert "Add libFuzzer shared object build output" 2020-08-05 12:11:24 -07:00
LinkTimeOptimization.rst [LTO][Legacy] Add new API to query Mach-O CPU (sub)type 2020-02-28 12:56:05 -08:00
LoopTerminology.rst [docs] Revise loop terminology reference. 2020-10-05 10:28:04 -05:00
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 [globalisel][docs] Rework GMIR documentation and add an early GenericOpcode reference 2019-11-05 15:16:43 -08:00
Makefile.sphinx
MarkdownQuickstartTemplate.md Doc: Links should use https 2020-03-22 22:49:33 +01:00
MarkedUpDisassembly.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
MeetupGuidelines.rst
MemTagSanitizer.rst Fix MemTagSanitizer docs to point at Armv8.5-A MTE 2020-03-05 17:23:58 +00:00
MemorySSA.rst [docs] Fix typos 2020-08-09 19:31:49 -07:00
MergeFunctions.rst MergeFunctions.rst - multiply vs shift typo (PR44717) 2020-03-23 10:13:25 +00:00
NVPTXUsage.rst
ORCv2.rst [docs] Update OrcV1 removal timeline. 2020-09-14 14:23:20 -07:00
OptBisect.rst [LegacyPassManager] Delete BasicBlockPass/Manager. 2019-10-30 11:40:16 -07:00
Packaging.rst update of the llvm doc: we moved to git 2020-03-22 22:36:21 +01:00
Passes.rst [ConstProp] Remove ConstantPropagation 2020-08-26 15:51:30 -07:00
Phabricator.rst Document the `--verbatim` flag from arc to update the description for a phabricator revision 2020-09-23 18:01:10 +00:00
ProgrammersManual.rst docs: Emphasize ArrayRef over SmallVectorImpl 2020-10-06 18:13:52 -04:00
Projects.rst
README.txt Doc: Links should use https 2020-03-22 22:49:33 +01:00
Reference.rst [docs] LLVM Security Group and Process 2020-07-10 15:24:02 -07:00
ReleaseNotes.rst Reapply "OpaquePtr: Add type to sret attribute" 2020-10-16 11:05:02 -04:00
ReleaseProcess.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
Remarks.rst [Remarks] Extend the RemarkStreamer to support other emitters 2020-02-04 17:16:02 -08:00
ReportingGuide.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
ScudoHardenedAllocator.rst
Security.rst Add expected response time and escalation path to the security docs 2020-10-13 10:57:06 +02:00
SegmentedStacks.rst
SourceLevelDebugging.rst [DebugInfo][flang]Added support for representing Fortran assumed length strings 2020-08-22 10:13:40 +05:30
SpeculativeLoadHardening.md Fix a few spellos in docs. 2019-09-13 14:58:24 +00:00
SphinxQuickstartTemplate.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
StackMaps.rst
StackSafetyAnalysis.rst
Statepoints.rst Remove inline gc arguments from statepoints 2020-08-14 19:44:24 -07:00
SupportLibrary.rst
SystemLibrary.rst
TableGenFundamentals.rst
TestSuiteGuide.md [docs] Fix typos 2020-08-09 19:31:49 -07:00
TestSuiteMakefileGuide.rst
TestingGuide.rst Add test utility 'split-file' 2020-08-03 20:42:09 -07:00
TransformMetadata.rst Insert missing bracket in docs. 2020-09-08 15:20:39 -07:00
TypeMetadata.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
UserGuides.rst Reland [docs][NewPM] Add docs for writing NPM passes 2020-09-14 16:06:19 -07:00
Vectorizers.rst [Docs] remove unused arguments in documentation examples on vectorization passes 2020-07-27 10:20:26 +01:00
WritingAnLLVMBackend.rst Update spelling of {analyze,insert,remove}Branch in strings and comments 2020-01-21 10:15:38 -06:00
WritingAnLLVMNewPMPass.rst [Docs][NewPM] Add note about required passes 2020-09-28 21:45:14 -07:00
WritingAnLLVMPass.rst Reland [docs][NewPM] Add docs for writing NPM passes 2020-09-14 16:06:19 -07:00
XRay.rst [xray] Function coverage groups 2020-09-24 22:09:53 -04:00
XRayExample.rst
XRayFDRFormat.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
YamlIO.rst remove a trailing space character (test commit) 2020-01-27 15:01:55 -08:00
conf.py Bump forgotten version nbr in llvm/docs/conf.py 2020-08-05 17:11:59 +02:00
doxygen-mainpage.dox
doxygen.cfg.in [docs] update mathjax path in doxygen 2020-02-07 16:26:35 +00:00
gcc-loops.png
index.rst [docs] LLVM Security Group and Process 2020-07-10 15:24:02 -07:00
linpack-pc.png
llvm-objdump.1 [llvm-objdump] Implement --prefix option 2020-10-16 17:50:42 +01:00
loop-guard.svg [docs] Revise loop terminology reference. 2020-10-05 10:28:04 -05:00
loop-irreducible.svg [docs] Revise loop terminology reference. 2020-10-05 10:28:04 -05:00
loop-merge.svg [docs] Revise loop terminology reference. 2020-10-05 10:28:04 -05:00
loop-nested.svg [docs] Revise loop terminology reference. 2020-10-05 10:28:04 -05:00
loop-nonmaximal.svg [docs] Revise loop terminology reference. 2020-10-05 10:28:04 -05:00
loop-separate.svg [docs] Revise loop terminology reference. 2020-10-05 10:28:04 -05:00
loop-single.svg [docs] Revise loop terminology reference. 2020-10-05 10:28:04 -05:00
loop-terminology-guarded-loop.png [LoopTerminology] Rotated Loops images 2020-03-17 01:02:19 +02:00
loop-terminology-initial-loop.png [LoopTerminology] Rotated Loops images 2020-03-17 01:02:19 +02:00
loop-terminology-rotated-loop.png [LoopTerminology] Rotated Loops images 2020-03-17 01:02:19 +02:00
loop-terminology.svg [docs] Revise loop terminology reference. 2020-10-05 10:28:04 -05:00
make.bat
re_format.7
speculative_load_hardening_microbenchmarks.png
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 <https://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` <-> `https://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.
`https://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