llvm-project/llvm/docs
Matt Arsenault 8d4b74ac3f AMDGPU: Don't consider whether amdgpu-flat-work-group-size was set
It should be semantically identical if it was set to the same value as
the default. Also improve the documentation.
2021-10-22 16:23:50 -04:00
..
AMDGPU [AMDGPU][MC][NFC][DOC] Updated description of registers 2021-09-03 13:09:54 +03:00
CommandGuide [llvm-readelf][docs] Add missing options and details to the help output and the command guide 2021-10-07 17:11:02 +01:00
DependenceGraphs Fix some typos in the llvm docs 2021-08-31 21:31:20 +02:00
Frontend
GlobalISel Revert @llvm.isnan intrinsic patchset. 2021-09-02 13:53:56 +03:00
HistoricalNotes
PDB
Proposals
TableGen Fix some typos in the llvm docs 2021-08-31 21:31:20 +02:00
_ocamldoc
_static
_templates
_themes/llvm-theme
tutorial Reformulate OrcJIT tutorial doc to make it more clear. 2021-09-03 04:59:37 +00:00
AMDGPUDwarfExtensionsForHeterogeneousDebugging.rst
AMDGPUInstructionNotation.rst [AMDGPU][MC][NFC][DOC] Updated AMD GPU assembler syntax description. 2021-08-27 17:23:20 +03:00
AMDGPUInstructionSyntax.rst [AMDGPU][MC][NFC][DOC] Updated AMD GPU assembler syntax description. 2021-08-27 17:23:20 +03:00
AMDGPUModifierSyntax.rst [AMDGPU][MC][NFC][DOC] Updated AMD GPU assembler syntax description. 2021-08-27 17:23:20 +03:00
AMDGPUOperandSyntax.rst [AMDGPU][MC][NFC][DOC] Updated description of registers 2021-09-03 13:09:54 +03:00
AMDGPUUsage.rst AMDGPU: Don't consider whether amdgpu-flat-work-group-size was set 2021-10-22 16:23:50 -04:00
ARM-BE-bitcastfail.png
ARM-BE-bitcastsuccess.png
ARM-BE-ld1.png
ARM-BE-ldr.png
AddingConstrainedIntrinsics.rst
AdvancedBuilds.rst
AliasAnalysis.rst
Atomics.rst
Benchmarking.rst
BigEndianNEON.rst
BitCodeFormat.rst [clang][Codegen] Introduce the disable_sanitizer_instrumentation attribute 2021-08-20 14:01:06 +02:00
BlockFrequencyTerminology.rst
BranchWeightMetadata.rst
BugLifeCycle.rst
Bugpoint.rst
BugpointRedesign.md
BuildingADistribution.rst
CFIVerify.rst
CMake.rst Remove unused parallel-libs project 2021-10-21 14:34:39 -07:00
CMakeLists.txt
CMakePrimer.rst
CodeGenerator.rst
CodeOfConduct.rst
CodeReview.rst
CodingStandards.rst [docs] Fix broken link rendering in the LLVM Coding Standards. 2021-10-21 11:12:33 +02:00
CommandLine.rst
CompileCudaWithLLVM.rst
CompilerWriterInfo.rst
Contributing.rst
Coroutines.rst
CoverageMappingFormat.rst
DebuggingJITedCode.rst
DeveloperPolicy.rst
Docker.rst
ExceptionHandling.rst
ExtendedIntegerResults.txt
ExtendingLLVM.rst
Extensions.rst
FAQ.rst
FaultMaps.rst
FuzzingLLVM.rst
GarbageCollection.rst
GetElementPtr.rst
GettingInvolved.rst first draft of a written policy around git repos 2021-10-19 08:05:37 +00:00
GettingStarted.rst [docs] Mention DragonFlyBSD as a supported platform for LLVM. 2021-10-16 13:20:10 +02:00
GettingStartedTutorials.rst [docs] Add a new tutorial that talk about how to make a change to llvm 2021-08-30 07:01:04 +00:00
GettingStartedVS.rst Fix some typos in the llvm docs 2021-08-31 21:31:20 +02:00
GitBisecting.rst
GitRepositoryPolicy.md first draft of a written policy around git repos 2021-10-19 08:05:37 +00:00
GoldPlugin.rst
GwpAsan.rst
HowToAddABuilder.rst Fix URLs to the prod/staging buildbot master in the doc 2021-09-28 06:18:26 +00:00
HowToBuildOnARM.rst
HowToBuildWindowsItaniumPrograms.rst [llvm] Fix typos in documentation (NFC) 2021-08-28 06:37:03 -07:00
HowToBuildWithPGO.rst
HowToCrossCompileBuiltinsOnArm.rst [test] Migrate -gcc-toolchain with space separator to --gcc-toolchain= 2021-08-20 15:24:58 -07:00
HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst
HowToUpdateDebugInfo.rst
HowToUseAttributes.rst
HowToUseInstrMappings.rst
InAlloca.rst
JITLink.rst Fix some typos in the llvm docs 2021-08-31 21:31:20 +02:00
LangRef.rst [docs] [NFC] Clarify the datalayout documentation 2021-10-12 23:21:48 +05:30
Lexicon.rst
LibFuzzer.rst
LinkTimeOptimization.rst
LoopTerminology.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 [MIRParser] Add support for IsInlineAsmBrIndirectTarget 2021-10-07 19:08:01 +01:00
MarkdownQuickstartTemplate.md [doc] added section on generating the html doc 2021-08-09 07:27:56 +00:00
MarkedUpDisassembly.rst
MeetupGuidelines.rst
MemTagSanitizer.rst
MemorySSA.rst
MergeFunctions.rst
MyFirstTypoFix.rst [docs] Fix typo and minor text changes in MyFirstTypoFix 2021-10-06 08:31:56 +00:00
NVPTXUsage.rst
NewPassManager.rst [CMake] Change -DENABLE_EXPERIMENTAL_NEW_PASS_MANAGER=off to -DLLVM_ENABLE_NEW_PASS_MANAGER=off 2021-08-26 14:25:31 -07:00
ORCv2.rst
OpaquePointers.rst
OptBisect.rst
Packaging.rst
Passes.rst Fix some typos in the llvm docs 2021-08-31 21:31:20 +02:00
Phabricator.rst Address a rst format error caught by buildbot 2021-10-05 18:58:08 -07:00
Phabricator_premerge_results.png
Phabricator_premerge_unit_tests.png
ProgrammersManual.rst Support: Add Expected<T>::moveInto() to avoid extra names 2021-10-22 11:47:03 -07:00
Projects.rst
README.txt Replace references to Makefile.sphinx 2021-10-22 15:32:12 +02:00
Reference.rst
ReleaseNotes.rst [LLVM-C]Add LLVMAddMetadataToInst, deprecated LLVMSetInstDebugLocation. 2021-10-22 11:21:28 +01:00
ReleaseProcess.rst
Remarks.rst
ReportingGuide.rst
ScudoHardenedAllocator.rst [llvm] Fix typos in documentation (NFC) 2021-08-28 06:37:03 -07:00
Security.rst Adding an Nvidia representative to security group 2021-08-18 12:08:11 +02:00
SegmentedStacks.rst
SourceLevelDebugging.rst
SpeculativeLoadHardening.md
SphinxQuickstartTemplate.rst [docs] Document how to install sphinx and recommonmark on Ubuntu 2021-08-19 18:24:17 +03:00
StackMaps.rst
StackSafetyAnalysis.rst
Statepoints.rst
SupportLibrary.rst
SupportPolicy.rst
SystemLibrary.rst
TableGenFundamentals.rst
TestSuiteGuide.md
TestSuiteMakefileGuide.rst
TestingGuide.rst llvm doc: remove the old reference to subversion and add a link to the GH repo instead 2021-09-18 12:45:32 +02:00
TransformMetadata.rst
TypeMetadata.rst
UserGuides.rst Fix some typos in the llvm docs 2021-08-31 21:31:20 +02:00
Vectorizers.rst
WritingAnLLVMBackend.rst
WritingAnLLVMNewPMPass.rst
WritingAnLLVMPass.rst
XRay.rst
XRayExample.rst [docs] Change llvm-xray options to use the preferred double-dash forms 2021-08-15 21:09:35 -07:00
XRayFDRFormat.rst
YamlIO.rst
buildbot_worker_contact.png
conf.py
doxygen-mainpage.dox
doxygen.cfg.in
epilogue-vectorization-cfg.png
gcc-loops.png
index.rst
linpack-pc.png
llvm-objdump.1
loop-guard.svg
loop-irreducible.svg
loop-merge.svg
loop-nested.svg
loop-nonmaximal.svg
loop-separate.svg
loop-single.svg
loop-terminology-guarded-loop.png
loop-terminology-initial-loop.png
loop-terminology-rotated-loop.png
loop-terminology.svg
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 llvm/docs/
    sphinx-build -b linkcheck . _build/lintcheck/
    # report will be generated in _build/lintcheck/output.txt

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

Install doxygen <https://www.doxygen.nl/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