maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/llvm/docs/UserGuides.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

209 lines
5.6 KiB
ReStructuredText
Raw Normal View History

Docs: Move Documentation sections to separate pages. Updates the links on the homepage by moving the User Guides, Programming Documentation, and Subsystem Documentation sections to separate pages. Also changes "Overview" to "About" at the top of the LLVM Docs homepage. This work is part of the Google Season of Docs project. llvm-svn: 371096
2019-09-06 01:30:52 +08:00
User Guides
===========
NOTE: If you are a user who is only interested in using an LLVM-based compiler,
Doc: Links should use https
2020-03-23 05:42:03 +08:00
you should look into `Clang <https://clang.llvm.org>`_ instead. The
Docs: Move Documentation sections to separate pages. Updates the links on the homepage by moving the User Guides, Programming Documentation, and Subsystem Documentation sections to separate pages. Also changes "Overview" to "About" at the top of the LLVM Docs homepage. This work is part of the Google Season of Docs project. llvm-svn: 371096
2019-09-06 01:30:52 +08:00
documentation here is intended for users who have a need to work with the
intermediate LLVM representation.
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
.. contents::
:local:
Docs: Move Documentation sections to separate pages. Updates the links on the homepage by moving the User Guides, Programming Documentation, and Subsystem Documentation sections to separate pages. Also changes "Overview" to "About" at the top of the LLVM Docs homepage. This work is part of the Google Season of Docs project. llvm-svn: 371096
2019-09-06 01:30:52 +08:00
.. toctree::
:hidden:
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
AddingConstrainedIntrinsics
AdvancedBuilds
AliasAnalysis
AMDGPUUsage
Benchmarking
BigEndianNEON
BuildingADistribution
[Docs] Moves Control Flow Document to User Guides Moves Control Flow document from Reference docs page to User guides page. llvm-svn: 374733
2019-10-14 04:05:22 +08:00
CFIVerify
Docs: Move Documentation sections to separate pages. Updates the links on the homepage by moving the User Guides, Programming Documentation, and Subsystem Documentation sections to separate pages. Also changes "Overview" to "About" at the top of the LLVM Docs homepage. This work is part of the Google Season of Docs project. llvm-svn: 371096
2019-09-06 01:30:52 +08:00
CMake
CMakePrimer
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
CodeGenerator
CodeOfConduct
CommandLine
CompileCudaWithLLVM
CoverageMappingFormat
DebuggingJITedCode
Docker
ExtendingLLVM
GoldPlugin
Docs: Move Documentation sections to separate pages. Updates the links on the homepage by moving the User Guides, Programming Documentation, and Subsystem Documentation sections to separate pages. Also changes "Overview" to "About" at the top of the LLVM Docs homepage. This work is part of the Google Season of Docs project. llvm-svn: 371096
2019-09-06 01:30:52 +08:00
HowToBuildOnARM
HowToBuildWithPGO
HowToCrossCompileBuiltinsOnArm
HowToCrossCompileLLVM
[docs] Sketch outline for HowToUpdateDebugInfo.rst Summary: Sketch the outline for a new document that explains how to update debug info in various kinds of code transformations. Some of the guidelines that belong in HowToUpdateDebugInfo.rst were in SourceLevelDebugging.rst already under the debugify section. It seems like the distinction between the two docs ought to be that the former is more prescriptive, while the latter is more descriptive. To that end I've consolidated the "how to update debug info" guidelines which were in SourceLevelDebugging.rst into the new doc, along with the information about using "debugify" to test transformations. Since we've added a mir-debugify pass, I've described that as well. Reviewers: aprantl, jmorse, chrisjackson, dsanders Subscribers: llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D80052
2020-05-16 08:13:18 +08:00
HowToUpdateDebugInfo
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
LinkTimeOptimization
LoopTerminology
Docs: Move Documentation sections to separate pages. Updates the links on the homepage by moving the User Guides, Programming Documentation, and Subsystem Documentation sections to separate pages. Also changes "Overview" to "About" at the top of the LLVM Docs homepage. This work is part of the Google Season of Docs project. llvm-svn: 371096
2019-09-06 01:30:52 +08:00
MarkdownQuickstartTemplate
[Docs] Adds section for Additional Topics on Reference page Adds a new section for Additional Topics on the Reference documentation page. Also moves Support Library topic to User Guides page. llvm-svn: 374230
2019-10-10 05:09:09 +08:00
MemorySSA
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
MergeFunctions
MCJITDesignAndImplementation
NVPTXUsage
Docs: Move Documentation sections to separate pages. Updates the links on the homepage by moving the User Guides, Programming Documentation, and Subsystem Documentation sections to separate pages. Also changes "Overview" to "About" at the top of the LLVM Docs homepage. This work is part of the Google Season of Docs project. llvm-svn: 371096
2019-09-06 01:30:52 +08:00
Phabricator
Passes
ReportingGuide
Remarks
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
SourceLevelDebugging
[Docs] Adds section for Additional Topics on Reference page Adds a new section for Additional Topics on the Reference documentation page. Also moves Support Library topic to User Guides page. llvm-svn: 374230
2019-10-10 05:09:09 +08:00
StackSafetyAnalysis
SupportLibrary
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
TableGen/index
TableGenFundamentals
Vectorizers
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
WritingAnLLVMPass
Reland [docs][NewPM] Add docs for writing NPM passes As to not conflict with the legacy PM example passes under llvm/lib/Transforms/Hello, this is under HelloNew. This makes the CMakeLists.txt and general directory structure less confusing for people following the example. Much of the doc structure was taken from WritinAnLLVMPass.rst. This adds a HelloWorld pass which simply prints out each function name. More will follow after this, e.g. passes over different units of IR, analyses. https://llvm.org/docs/WritingAnLLVMPass.html contains a lot more. Relanded with missing "Support" dependency in LLVMBuild.txt. Reviewed By: ychen, asbirlea Differential Revision: https://reviews.llvm.org/D86979
2020-09-01 09:36:11 +08:00
WritingAnLLVMNewPMPass
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
WritingAnLLVMBackend
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
yaml2obj
Docs: Move Documentation sections to separate pages. Updates the links on the homepage by moving the User Guides, Programming Documentation, and Subsystem Documentation sections to separate pages. Also changes "Overview" to "About" at the top of the LLVM Docs homepage. This work is part of the Google Season of Docs project. llvm-svn: 371096
2019-09-06 01:30:52 +08:00
[Docs] Adds new section to User Guides page Adds a section to the User Guides page for articles related to building, packaging, and distributing LLVM. Includes sub-sections for CMake, Clang, and Docker. llvm-svn: 373113
2019-09-28 03:12:00 +08:00
Clang
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
-----
[Docs] Adds new section to User Guides page Adds a section to the User Guides page for articles related to building, packaging, and distributing LLVM. Includes sub-sections for CMake, Clang, and Docker. llvm-svn: 373113
2019-09-28 03:12:00 +08:00
Docs: Move Documentation sections to separate pages. Updates the links on the homepage by moving the User Guides, Programming Documentation, and Subsystem Documentation sections to separate pages. Also changes "Overview" to "About" at the top of the LLVM Docs homepage. This work is part of the Google Season of Docs project. llvm-svn: 371096
2019-09-06 01:30:52 +08:00
:doc:`HowToBuildOnARM`
Notes on building and testing LLVM/Clang on ARM.
:doc:`HowToBuildWithPGO`
Notes on building LLVM/Clang with PGO.
:doc:`HowToCrossCompileLLVM`
Notes on cross-building and testing LLVM/Clang.
[Docs] Adds new section to User Guides page Adds a section to the User Guides page for articles related to building, packaging, and distributing LLVM. Includes sub-sections for CMake, Clang, and Docker. llvm-svn: 373113
2019-09-28 03:12:00 +08:00
`How to build the C, C++, ObjC, and ObjC++ front end`__
Instructions for building the clang front-end from source.
Doc: Links should use https
2020-03-23 05:42:03 +08:00
.. __: https://clang.llvm.org/get_started.html
[Docs] Adds new section to User Guides page Adds a section to the User Guides page for articles related to building, packaging, and distributing LLVM. Includes sub-sections for CMake, Clang, and Docker. llvm-svn: 373113
2019-09-28 03:12:00 +08:00
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
:doc:`CoverageMappingFormat`
This describes the format and encoding used for LLVM’s code coverage mapping.
[Docs] Moves Control Flow Document to User Guides Moves Control Flow document from Reference docs page to User guides page. llvm-svn: 374733
2019-10-14 04:05:22 +08:00
:doc:`CFIVerify`
A description of the verification tool for Control Flow Integrity.
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
LLVM Builds and Distributions
-----------------------------
:doc:`BuildingADistribution`
A best-practices guide for using LLVM's CMake build system to package and
distribute LLVM-based tools.
:doc:`CMake`
An addendum to the main Getting Started guide for those using the `CMake
build system <http://www.cmake.org>`_.
[Docs] Adds new section to User Guides page Adds a section to the User Guides page for articles related to building, packaging, and distributing LLVM. Includes sub-sections for CMake, Clang, and Docker. llvm-svn: 373113
2019-09-28 03:12:00 +08:00
:doc:`Docker`
A reference for using Dockerfiles provided with LLVM.
[Docs] Adds section for Additional Topics on Reference page Adds a new section for Additional Topics on the Reference documentation page. Also moves Support Library topic to User Guides page. llvm-svn: 374230
2019-10-10 05:09:09 +08:00
:doc:`Support Library <SupportLibrary>`
This document describes the LLVM Support Library (``lib/Support``) and
[Docs] Add the entry for `Advanced builds` in UserGuide.rst Also add a link to it from ThinLTO.rst.
2020-06-02 08:09:40 +08:00
how to keep LLVM source code portable.
:doc:`AdvancedBuilds`
This document describes more advanced build configurations.
[Docs] Adds section for Additional Topics on Reference page Adds a new section for Additional Topics on the Reference documentation page. Also moves Support Library topic to User Guides page. llvm-svn: 374230
2019-10-10 05:09:09 +08:00
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
Optimizations
-------------
[Docs] Adds new section to User Guides page Adds a section to the User Guides page for articles related to building, packaging, and distributing LLVM. Includes sub-sections for CMake, Clang, and Docker. llvm-svn: 373113
2019-09-28 03:12:00 +08:00
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
:doc:`WritingAnLLVMPass`
Information on how to write LLVM transformations and analyses.
[Docs] Adds new section to User Guides page Adds a section to the User Guides page for articles related to building, packaging, and distributing LLVM. Includes sub-sections for CMake, Clang, and Docker. llvm-svn: 373113
2019-09-28 03:12:00 +08:00
Reland [docs][NewPM] Add docs for writing NPM passes As to not conflict with the legacy PM example passes under llvm/lib/Transforms/Hello, this is under HelloNew. This makes the CMakeLists.txt and general directory structure less confusing for people following the example. Much of the doc structure was taken from WritinAnLLVMPass.rst. This adds a HelloWorld pass which simply prints out each function name. More will follow after this, e.g. passes over different units of IR, analyses. https://llvm.org/docs/WritingAnLLVMPass.html contains a lot more. Relanded with missing "Support" dependency in LLVMBuild.txt. Reviewed By: ychen, asbirlea Differential Revision: https://reviews.llvm.org/D86979
2020-09-01 09:36:11 +08:00
:doc:`WritingAnLLVMNewPMPass`
Information on how to write LLVM transformations under the new pass
manager.
Docs: Move Documentation sections to separate pages. Updates the links on the homepage by moving the User Guides, Programming Documentation, and Subsystem Documentation sections to separate pages. Also changes "Overview" to "About" at the top of the LLVM Docs homepage. This work is part of the Google Season of Docs project. llvm-svn: 371096
2019-09-06 01:30:52 +08:00
:doc:`Passes`
A list of optimizations and analyses implemented in LLVM.
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
:doc:`StackSafetyAnalysis`
This document describes the design of the stack safety analysis of local
variables.
:doc:`MergeFunctions`
Describes functions merging optimization.
:doc:`AliasAnalysis`
Information on how to write a new alias analysis implementation or how to
use existing analyses.
[Docs] Adds section for Additional Topics on Reference page Adds a new section for Additional Topics on the Reference documentation page. Also moves Support Library topic to User Guides page. llvm-svn: 374230
2019-10-10 05:09:09 +08:00
:doc:`MemorySSA`
Information about the MemorySSA utility in LLVM, as well as how to use it.
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
:doc:`LoopTerminology`
A document describing Loops and associated terms as used in LLVM.
Docs: Move Documentation sections to separate pages. Updates the links on the homepage by moving the User Guides, Programming Documentation, and Subsystem Documentation sections to separate pages. Also changes "Overview" to "About" at the top of the LLVM Docs homepage. This work is part of the Google Season of Docs project. llvm-svn: 371096
2019-09-06 01:30:52 +08:00
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
:doc:`Vectorizers`
This document describes the current status of vectorization in LLVM.
:doc:`LinkTimeOptimization`
This document describes the interface between LLVM intermodular optimizer
and the linker and its design
:doc:`GoldPlugin`
How to build your programs with link-time optimization on Linux.
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
:doc:`Remarks`
A reference on the implementation of remarks in LLVM.
Docs: Move Documentation sections to separate pages. Updates the links on the homepage by moving the User Guides, Programming Documentation, and Subsystem Documentation sections to separate pages. Also changes "Overview" to "About" at the top of the LLVM Docs homepage. This work is part of the Google Season of Docs project. llvm-svn: 371096
2019-09-06 01:30:52 +08:00
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
:doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
This document describes the design and philosophy behind the LLVM
source-level debugger.
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
Code Generation
---------------
Docs: Move Documentation sections to separate pages. Updates the links on the homepage by moving the User Guides, Programming Documentation, and Subsystem Documentation sections to separate pages. Also changes "Overview" to "About" at the top of the LLVM Docs homepage. This work is part of the Google Season of Docs project. llvm-svn: 371096
2019-09-06 01:30:52 +08:00
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
:doc:`WritingAnLLVMBackend`
Information on how to write LLVM backends for machine targets.
Docs: Move Documentation sections to separate pages. Updates the links on the homepage by moving the User Guides, Programming Documentation, and Subsystem Documentation sections to separate pages. Also changes "Overview" to "About" at the top of the LLVM Docs homepage. This work is part of the Google Season of Docs project. llvm-svn: 371096
2019-09-06 01:30:52 +08:00
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
:doc:`CodeGenerator`
The design and implementation of the LLVM code generator. Useful if you are
working on retargetting LLVM to a new architecture, designing a new codegen
pass, or enhancing existing components.
:doc:`TableGen <TableGen/index>`
Describes the TableGen tool, which is used heavily by the LLVM code
generator.
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
===
JIT
===
:doc:`MCJITDesignAndImplementation`
Describes the inner workings of MCJIT execution engine.
:doc:`DebuggingJITedCode`
How to debug JITed code with GDB.
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
Additional Topics
-----------------
[Docs] Removes Programming Documentation page Removes Programming Documentation page. Also moves existing topics on Programming Documentation page to User Guides and Reference pages. llvm-svn: 373856
2019-10-07 00:10:11 +08:00
:doc:`CommandLine`
Provides information on using the command line parsing library.
:doc:`ExtendingLLVM`
Look here to see how to add instructions and intrinsics to LLVM.
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
:doc:`AddingConstrainedIntrinsics`
Gives the steps necessary when adding a new constrained math intrinsic
to LLVM.
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
:doc:`HowToCrossCompileBuiltinsOnArm`
Notes on cross-building and testing the compiler-rt builtins for Arm.
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
:doc:`BigEndianNEON`
LLVM's support for generating NEON instructions on big endian ARM targets is
somewhat nonintuitive. This document explains the implementation and rationale.
:doc:`CompileCudaWithLLVM`
LLVM support for CUDA.
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
:doc:`NVPTXUsage`
This document describes using the NVPTX backend to compile GPU kernels.
:doc:`AMDGPUUsage`
[AMDGPU] Move DWARF proposal to separate file - Move DWARF proposal for heterogeneous debugging to a separate file. - Add references. Differential Revision: https://reviews.llvm.org/D70523
2020-04-14 12:55:43 +08:00
This document describes using the AMDGPU backend to compile GPU kernels.
[AMDGPU] Fix DWARF extensions User Guide table of contents
2020-07-30 13:10:21 +08:00
:doc:`AMDGPUDwarfExtensionsForHeterogeneousDebugging`
This document describes DWARF extensions to support heterogeneous debugging
[docs] Sketch outline for HowToUpdateDebugInfo.rst Summary: Sketch the outline for a new document that explains how to update debug info in various kinds of code transformations. Some of the guidelines that belong in HowToUpdateDebugInfo.rst were in SourceLevelDebugging.rst already under the debugify section. It seems like the distinction between the two docs ought to be that the former is more prescriptive, while the latter is more descriptive. To that end I've consolidated the "how to update debug info" guidelines which were in SourceLevelDebugging.rst into the new doc, along with the information about using "debugify" to test transformations. Since we've added a mir-debugify pass, I've described that as well. Reviewers: aprantl, jmorse, chrisjackson, dsanders Subscribers: llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D80052
2020-05-16 08:13:18 +08:00
for targets such as the AMDGPU backend.