1
0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-23 11:13:28 +01:00
llvm-mirror/docs
Tony 9d242b30fd [AMDGPU] DWARF proposal review feedback
- Rename DW_OP_LLVM_offset_constu to DW_OP_LLVM_offset_uconst to
  matches DW_OP_plus_uconst.
- Correct DW_OP_LLVM_call_ref to be DW_OP_call_ref.
- Move proposed changes to a separate section to clarify that the
  introduction section is not part of the changes.
- Fix formatting typos and add missing reference.
- Clarify why DW_OP_LLVM_offset et al do not wrap on overflow.
- Correct syntax of augmentation string.

Differential Revision: https://reviews.llvm.org/D70523
2020-04-28 00:56:25 -04:00
..
_ocamldoc
_static
_templates
_themes/llvm-theme
AMDGPU [AMDGPU][MC][DOC] Updated AMD GPU assembler syntax description. 2020-02-07 16:23:46 +03:00
CommandGuide [docs] Fix :option: links 2020-04-25 16:19:02 -06: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 [NFC] G_DYN_STACKALLOC realign iff align > 1, update documentation 2020-04-03 08:12:39 +00:00
HistoricalNotes Doc: Links should use https 2020-03-22 22:49:33 +01:00
PDB
Proposals [llvm] NFC: Fix trivial typo in rst and td files 2020-04-23 14:26:32 +09:00
TableGen [llvm] NFC: Fix trivial typo in rst and td files 2020-04-23 14:26:32 +09:00
tutorial [llvm] NFC: Fix trivial typo in rst and td files 2020-04-23 14:26:32 +09:00
AddingConstrainedIntrinsics.rst
AdvancedBuilds.rst
AliasAnalysis.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
AMDGPUDwarfProposalForHeterogeneousDebugging.rst [AMDGPU] DWARF proposal review feedback 2020-04-28 00:56:25 -04:00
AMDGPUInstructionNotation.rst
AMDGPUInstructionSyntax.rst
AMDGPUModifierSyntax.rst [AMDGPU][MC][DOC] Updated AMD GPU assembler syntax description. 2019-12-25 17:51:53 +03:00
AMDGPUOperandSyntax.rst [AMDGPU][MC][DOC] Updated AMD GPU assembler syntax description. 2019-12-25 17:51:53 +03:00
AMDGPUUsage.rst [llvm] NFC: Fix trivial typo in rst and td files 2020-04-23 14:26:32 +09:00
ARM-BE-bitcastfail.png
ARM-BE-bitcastsuccess.png
ARM-BE-ld1.png
ARM-BE-ldr.png
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
BlockFrequencyTerminology.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
BranchWeightMetadata.rst
BugLifeCycle.rst
Bugpoint.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
BugpointRedesign.md
BuildingADistribution.rst Remove AllTargetsAsmPrinters 2020-01-17 19:04:06 -05:00
CFIVerify.rst
CMake.rst [dfsan] Add "DataFlow" option to LLVM_USE_SANITIZER 2020-04-20 10:30:52 -07:00
CMakeLists.txt
CMakePrimer.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08: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 [docs] Document coding standard for error and warning messages 2020-03-31 12:41:17 +01:00
CommandLine.rst
CompileCudaWithLLVM.rst doc: use the right url to bugzilla 2020-03-22 22:49:40 +01:00
CompilerWriterInfo.rst [PowerPC][docs] Update Embedded PowerPC docs in Compiler Writers Info page 2019-12-30 20:22:37 +00:00
conf.py
Contributing.rst High-Level Code-Review Documentation Update 2020-03-07 04:20:18 +00:00
Coroutines.rst
CoverageMappingFormat.rst Reland: [Coverage] Revise format to reduce binary size 2020-02-28 18:12:04 -08:00
DebuggingJITedCode.rst
DeveloperPolicy.rst [docs] use git diff instead of git format-patch 2020-04-02 07:20:27 -07:00
Docker.rst update of the llvm doc: we moved to git 2020-03-22 22:36:21 +01:00
doxygen-mainpage.dox
doxygen.cfg.in [docs] update mathjax path in doxygen 2020-02-07 16:26:35 +00:00
ExceptionHandling.rst Remove extra "\01" prefix in EH docs 2020-01-19 08:20:17 -08:00
ExtendedIntegerResults.txt
ExtendingLLVM.rst
Extensions.rst [llvm] NFC: Fix trivial typo in rst and td files 2020-04-23 14:26:32 +09: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
gcc-loops.png
GetElementPtr.rst
GettingInvolved.rst Add the CodeReview Documentation to GettingInvolved TOC 2020-03-07 04:55:46 +00:00
GettingStarted.rst [docs] use git diff instead of git format-patch 2020-04-02 07:20:27 -07:00
GettingStartedTutorials.rst
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
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
HowToSetUpLLVMStyleRTTI.rst [docs] Fix an RST error introduced in e823068306e. 2020-04-15 14:37:58 -07:00
HowToSubmitABug.rst update of the llvm doc: we moved to git 2020-03-22 22:36:21 +01:00
HowToUseAttributes.rst
HowToUseInstrMappings.rst [llvm] NFC: Fix trivial typo in rst and td files 2020-04-23 14:26:32 +09:00
InAlloca.rst
index.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
LangRef.rst Add IR constructs for preallocated (inalloca replacement) 2020-04-27 16:15:50 -07:00
Lexicon.rst [Lexicon] fix typo "may is" -> "is" 2020-04-26 19:35:25 +01:00
LibFuzzer.rst doc: use the right url to bugzilla 2020-03-22 22:49:40 +01:00
LinkTimeOptimization.rst [LTO][Legacy] Add new API to query Mach-O CPU (sub)type 2020-02-28 12:56:05 -08:00
linpack-pc.png
llvm-objdump.1
LLVMBuild.rst
LLVMBuild.txt Doc: Links should use https 2020-03-22 22:49:33 +01: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
LoopTerminology.rst [LoopTerminology] LCSSA: Fix typo in code sample 2020-04-12 04:40:55 +03:00
make.bat
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
MCJIT-creation.png
MCJIT-dyld-load.png
MCJIT-engine-builder.png
MCJIT-load-object.png
MCJIT-load.png
MCJIT-resolve-relocations.png
MCJITDesignAndImplementation.rst
MeetupGuidelines.rst
MemorySSA.rst
MemTagSanitizer.rst Fix MemTagSanitizer docs to point at Armv8.5-A MTE 2020-03-05 17:23:58 +00:00
MergeFunctions.rst MergeFunctions.rst - multiply vs shift typo (PR44717) 2020-03-23 10:13:25 +00:00
MIRLangRef.rst
NVPTXUsage.rst
OptBisect.rst
ORCv2.rst [ORC] Update ORCv2 docs to reflect removal of ExecutionSession::getMainJITDylib. 2020-04-13 12:52:44 -07:00
Packaging.rst update of the llvm doc: we moved to git 2020-03-22 22:36:21 +01:00
Passes.rst [LoopTerminology] LCSSA form 2020-03-31 15:30:59 +03:00
Phabricator.rst Add mention of advantages of arc in the Phabricator doc. 2020-04-04 03:22:29 +00:00
ProgrammersManual.rst [CallSite removal] Remove the text describing CallSite from the manual. 2020-04-23 22:17:19 -04:00
Projects.rst
re_format.7
README.txt Doc: Links should use https 2020-03-22 22:49:33 +01:00
Reference.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
ReleaseNotes.rst [Docs] Fixed formatting in release notes, NFC 2020-04-22 18:25:22 +01: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
SegmentedStacks.rst
SourceLevelDebugging.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
speculative_load_hardening_microbenchmarks.png
SpeculativeLoadHardening.md
SphinxQuickstartTemplate.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
StackMaps.rst
StackSafetyAnalysis.rst
Statepoints.rst [DOC] Remove too strong restriction for ‘llvm.experimental.gc.statepoint’ Intrinsic 2020-04-02 10:56:42 +07:00
SupportLibrary.rst
SystemLibrary.rst
TableGenFundamentals.rst
TestingGuide.rst NFC: Fix typos in TestingGuide documentation 2020-03-24 14:54:55 -04:00
TestSuiteGuide.md Doc: Links should use https 2020-03-22 22:49:33 +01:00
TestSuiteMakefileGuide.rst
TransformMetadata.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
TypeMetadata.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
UserGuides.rst [AMDGPU] Move DWARF proposal to separate file 2020-04-15 17:19:39 -04:00
Vectorizers.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
WritingAnLLVMBackend.rst Update spelling of {analyze,insert,remove}Branch in strings and comments 2020-01-21 10:15:38 -06:00
WritingAnLLVMPass.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
XRay.rst
XRayExample.rst
XRayFDRFormat.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
yaml2obj.rst
YamlIO.rst remove a trailing space character (test commit) 2020-01-27 15:01:55 -08:00

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