1
0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-22 10:42:39 +01:00
llvm-mirror/docs
Nikita Popov 159ef87203 [LangRef] Add elementtype attribute
This adds an elementtype(<ty>) attribute, which can be used to
attach an element type to a pointer typed argument. It is similar
to byval/byref in purpose, but unlike those does not carry any
specific semantics by itself. However, certain intrinsics may
require it and interpret it in specific ways.

The in-tree use cases for this that I'm currently aware of are:

    call ptr @llvm.preserve.array.access.index.p0.p0(ptr elementtype(%ty) %base, i32 %dim, i32 %index)
    call ptr @llvm.preserve.struct.access.index.p0.p0(ptr elementtype(%ty) %base, i32 %gep_index, i32 %di_index)
    call token @llvm.experimental.gc.statepoint.p0(i64 0, i32 0, ptr elementtype(void ()) @foo, i32 0, i32 0, i32 0, i32 0, ptr addrspace(1) %obj)

Notably, the gc.statepoint case needs a function as element type,
in which case the workaround of adding a separate %ty undef
argument would not work, as arguments cannot be unsized.

Differential Revision: https://reviews.llvm.org/D105407
2021-07-15 18:04:25 +02:00
..
_ocamldoc
_static
_templates
_themes/llvm-theme
AMDGPU [AMDGPU][MC][NFC][DOC] Updated AMD GPU assembler syntax description. 2021-05-14 16:13:30 +03:00
CommandGuide [docs] Fix :option:--file-header reference in llvm-readelf.rst after D105532 2021-07-14 12:39:22 -07:00
DependenceGraphs [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
Frontend [llvm] Fix typos in documentation (NFC) 2021-02-27 10:09:23 -08:00
GlobalISel [GISel] Support llvm.memcpy.inline 2021-06-30 12:39:05 -07:00
HistoricalNotes
PDB
Proposals [VPlan] Add VPDef class. 2020-11-17 16:18:11 +00:00
TableGen [TableGen] Add the !find bang operator 2021-04-28 09:51:00 -04:00
tutorial Reformulate OrcJIT tutorial doc to make it more clear. 2021-07-14 05:48:01 +00:00
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] Remove no-aa from the alias analysis documentation 2021-03-04 00:35:52 -06:00
AMDGPUDwarfExtensionsForHeterogeneousDebugging.rst [NFC][AMDGPU] Correct typo in DWARF Extensions For Heterogeneous Debugging 2021-03-09 00:23:23 +00: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. 2021-05-14 16:13:30 +03:00
AMDGPUOperandSyntax.rst [AMDGPU][MC][NFC][DOC] Updated AMD GPU assembler syntax description. 2021-05-14 16:13:30 +03:00
AMDGPUUsage.rst [AMDGPU] Reserve AMDGPU ELF e_flags machine 0x44 2021-07-15 06:46:27 +00:00
ARM-BE-bitcastfail.png
ARM-BE-bitcastsuccess.png
ARM-BE-ld1.png
ARM-BE-ldr.png
Atomics.rst [AArch64] Out-of-line atomics (-moutline-atomics) implementation. 2020-11-20 13:30:12 +00:00
Benchmarking.rst Add some tips on benchmarking. 2017-05-24 16:39:12 +00:00
BigEndianNEON.rst
BitCodeFormat.rst [SanitizeCoverage] Add support for NoSanitizeCoverage function attribute 2021-05-25 12:57:14 +02:00
BlockFrequencyTerminology.rst
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
BugpointRedesign.md [Bugpoint redesign] Fix nonlocal URI link in doc 2019-08-09 21:48:47 +00:00
buildbot_worker_contact.png added section on CI system 2021-04-21 09:59:41 +02:00
BuildingADistribution.rst [cmake] Add support for multiple distributions 2021-05-12 11:13:18 -07:00
CFIVerify.rst [cfi-verify] Abort on unsupported targets 2018-07-16 15:26:44 +00:00
CMake.rst [docs] More CMAKE variable documentation 2021-07-15 06:56:49 -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 [docs][GISel]Added GISel documentation link 2021-06-24 00:55:00 +05:30
CodeOfConduct.rst [Conduct] Refine what "rare cases" means wrt violations outside our spaces. 2016-07-06 19:32:41 +00:00
CodeReview.rst [docs] Set Phabricator as the tool for pre-commit reviews 2021-06-07 11:50:52 -05:00
CodingStandards.rst Update references to 'master' branch. 2020-12-21 19:10:34 +00:00
CommandLine.rst [llvm] Fix typos in documentation (NFC) 2021-02-27 10:09:23 -08:00
CompileCudaWithLLVM.rst
CompilerWriterInfo.rst [XCore][docs] Fix XCore compiler writer documentation links. 2020-12-08 12:21:09 +00:00
conf.py [llvm][docs] Bump release number from 12 -> 13 2021-07-01 11:07:03 +00:00
Contributing.rst [docs] Fix up dead clang-format links after monorepo move. NFC 2021-03-30 14:29:35 -07:00
Coroutines.rst [LICM][Coroutine] Don't sink stores from loops with coro.suspend instructions 2021-03-03 15:21:57 -08:00
CoverageMappingFormat.rst [Coverage] Store compilation dir separately in coverage mapping 2021-02-18 14:34:39 -08:00
DebuggingJITedCode.rst [docs] Update DebuggingJITedCode page after fix in LLDB 2021-01-14 15:43:11 +01:00
DeveloperPolicy.rst [doc] typo fixes 2021-05-03 10:59:51 +02: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
epilogue-vectorization-cfg.png [LV] Epilogue Vectorization with Optimal Control Flow (Recommit) 2020-12-02 10:09:56 -05: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 Update references to 'master' branch. 2020-12-21 19:10:34 +00:00
FaultMaps.rst Fix the docs build 2017-02-07 20:36:03 +00:00
FuzzingLLVM.rst
GarbageCollection.rst [Docs] Correct Boehm collector weblink in GarbageCollection.rst 2021-04-18 17:30:17 +05:30
gcc-loops.png
GetElementPtr.rst
GettingInvolved.rst [docs] Describe reporting security issues on the chromium tracker. 2021-05-19 15:21:50 -07:00
GettingStarted.rst [RFC][debuginfo-test] Rename debug-info lit tests for general purposes 2021-06-28 11:31:40 +01:00
GettingStartedTutorials.rst [Docs] Adds Documentation links to sidebar 2019-10-09 20:26:13 +00:00
GettingStartedVS.rst propose Chocolately as package manager 2021-03-19 16:15:18 +01:00
GitBisecting.rst Update references to 'master' branch. 2020-12-21 19:10:34 +00:00
GoldPlugin.rst [docs][gold] Fix a typo 2018-08-21 21:00:54 +00:00
GwpAsan.rst
HowToAddABuilder.rst Update filename to workers.py file in documentation 2021-01-22 00:20:26 -08:00
HowToBuildOnARM.rst Remove Python2 fallback and only advertise Python3 in the doc 2020-12-17 15:40:16 +01:00
HowToBuildWindowsItaniumPrograms.rst Reland: [Docs][Windows Itanium] Add a How-To document for Windows Itanium. 2021-03-09 01:36:34 +00:00
HowToBuildWithPGO.rst docs: Add pointer to cmake caches for PGO 2020-12-07 15:55:26 -05:00
HowToCrossCompileBuiltinsOnArm.rst [arm builtin crosscompile docs] add COMPILER_RT_BUILD_MEMPROF=OFF 2021-02-25 10:44:52 -05:00
HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst HowToReleaseLLVM: Update document to match the current release process 2020-12-21 15:16:11 -08:00
HowToSetUpLLVMStyleRTTI.rst [docs] Fix typos 2020-08-09 19:31:49 -07:00
HowToSubmitABug.rst [Docs] Update HowToSubmitABug 2021-02-02 21:19:20 -08:00
HowToUpdateDebugInfo.rst Recommit: "[Debugify][Original DI] Test dbg var loc preservation"" 2021-05-21 02:04:29 -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
index.rst [docs] LLVM Security Group and Process 2020-07-10 15:24:02 -07:00
JITLink.rst [docs][JITLink] Fix a typo (NFC) 2021-03-02 15:07:36 +01:00
LangRef.rst [LangRef] Add elementtype attribute 2021-07-15 18:04:25 +02:00
Lexicon.rst [llvm] Fix typos in documentation (NFC) 2021-02-27 10:09:23 -08:00
LibFuzzer.rst [libfuzzer] Update doc mentioning removed flags. 2021-05-18 22:40:42 -07:00
LinkTimeOptimization.rst
linpack-pc.png
llvm-objdump.1 [llvm-objdump] Implement --prefix-strip option 2021-03-24 13:22:35 +00: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
loop-terminology-initial-loop.png
loop-terminology-rotated-loop.png
loop-terminology.svg [docs] Revise loop terminology reference. 2020-10-05 10:28:04 -05:00
LoopTerminology.rst [LCSSA] Doc for special treatment of PHIs 2020-10-29 22:50:07 +02:00
make.bat
Makefile.sphinx
MarkdownQuickstartTemplate.md
MarkedUpDisassembly.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 Fix several accidental DOS line endings in source files 2016-01-03 17:22:03 +00:00
MeetupGuidelines.rst Add guidelines/recommendations for organizers of LLVM Socials 2019-05-14 07:20:58 +00:00
MemorySSA.rst [llvm] Fix typos in documentation (NFC) 2021-02-27 10:09:23 -08:00
MemTagSanitizer.rst
MergeFunctions.rst [llvm] Fix typos in documentation (NFC) 2021-02-27 10:09:23 -08:00
MIRLangRef.rst [llvm] Fix typos in documentation (NFC) 2021-02-27 10:09:23 -08:00
NewPassManager.rst [docs][NewPM] Add some instructions on how to invoke opt 2021-06-23 19:49:35 -07:00
NVPTXUsage.rst
OpaquePointers.rst [docs][OpaquePtr] Remove finished task 2021-07-14 14:36:41 -07:00
OptBisect.rst
ORCv2.rst s/setGenerator/addGenerator/ in the JIT docs. NFC 2021-04-15 15:54:28 -07:00
Packaging.rst
Passes.rst Use -cfg-func-name value as filter for -view-cfg, etc. 2021-06-16 23:54:51 +02:00
Phabricator_premerge_results.png [doc] added documentation for pre-merge testing 2021-04-27 16:53:16 +02:00
Phabricator_premerge_unit_tests.png [doc] added documentation for pre-merge testing 2021-04-27 16:53:16 +02:00
Phabricator.rst [doc] added documentation for pre-merge testing 2021-04-27 16:53:16 +02:00
ProgrammersManual.rst [llvm] Fix typos in documentation (NFC) 2021-02-27 10:09:23 -08:00
Projects.rst
re_format.7
README.txt
Reference.rst [docs][JITLink] Add a JITLink design and API document. 2021-02-24 21:04:35 +11:00
ReleaseNotes.rst [llvm-nm] Switch command line parsing from llvm::cl to OptTable 2021-07-07 13:34:33 -07:00
ReleaseProcess.rst
Remarks.rst [Remarks] Extend the RemarkStreamer to support other emitters 2020-02-04 17:16:02 -08:00
ReportingGuide.rst
ScudoHardenedAllocator.rst [docs][scudo] Update Scudo documentation 2021-04-13 08:41:56 -07:00
Security.rst [docs] Describe reporting security issues on the chromium tracker. 2021-05-19 15:21:50 -07:00
SegmentedStacks.rst
SourceLevelDebugging.rst [RemoveRedundantDebugValues] Add a Pass that removes redundant DBG_VALUEs 2021-07-14 04:29:42 -07:00
speculative_load_hardening_microbenchmarks.png
SpeculativeLoadHardening.md
SphinxQuickstartTemplate.rst
StackMaps.rst [llvm] Fix typos in documentation (NFC) 2021-02-27 10:09:23 -08:00
StackSafetyAnalysis.rst
Statepoints.rst [RS4GC] Introduce intrinsics to get base ptr and offset 2021-05-27 09:14:14 +07:00
SupportLibrary.rst
SupportPolicy.rst [docs] Adding a Support Policy 2020-11-07 21:06:05 +00:00
SystemLibrary.rst
TableGenFundamentals.rst
TestingGuide.rst [lit] Add the ability to parse regexes in Lit boolean expressions 2021-06-30 10:52:16 -04:00
TestSuiteGuide.md [flang][docs] Initial documentation for the Fortran LLVM Test Suite. 2021-05-26 15:59:55 -05:00
TestSuiteMakefileGuide.rst Adjust documentation for git migration. 2019-01-29 16:37:27 +00:00
TransformMetadata.rst Insert missing bracket in docs. 2020-09-08 15:20:39 -07:00
TypeMetadata.rst Update references to 'master' branch. 2020-12-21 19:10:34 +00:00
UserGuides.rst [docs] Add page on opaque pointer types 2021-05-13 15:10:27 -07:00
Vectorizers.rst [Docs] Fix incorrect return type for example code 2021-06-10 14:20:11 +08:00
WritingAnLLVMBackend.rst
WritingAnLLVMNewPMPass.rst [docs] Add documentation on using the new pass manager 2021-02-26 15:28:19 -08:00
WritingAnLLVMPass.rst [docs] Add documentation on using the new pass manager 2021-02-26 15:28:19 -08:00
XRay.rst [xray] Fix xray document spelling 2021-03-10 16:03:55 +11:00
XRayExample.rst [xray] Fix xray document spelling 2021-03-10 16:03:55 +11:00
XRayFDRFormat.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
yaml2obj.rst
YamlIO.rst [NFC][llvm][docs] YamlIO: StringRef validate -> std::string validate 2021-07-09 11:49:37 +02: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