mirror of
https://github.com/RPCS3/llvm.git
synced 2025-02-14 15:57:47 +00:00
7481935a8c
This commit moves several topics to new categories. It also removes a few duplicate links in Subsystem Documentation. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@372274 91177308-0d34-0410-b5e6-96231b3b80d8
93 lines
2.4 KiB
ReStructuredText
93 lines
2.4 KiB
ReStructuredText
User Guides
|
|
===========
|
|
|
|
For those new to the LLVM system.
|
|
|
|
NOTE: If you are a user who is only interested in using an LLVM-based compiler,
|
|
you should look into `Clang <http://clang.llvm.org>`_ instead. The
|
|
documentation here is intended for users who have a need to work with the
|
|
intermediate LLVM representation.
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
CMake
|
|
CMakePrimer
|
|
AdvancedBuilds
|
|
HowToBuildOnARM
|
|
HowToBuildWithPGO
|
|
HowToCrossCompileBuiltinsOnArm
|
|
HowToCrossCompileLLVM
|
|
GettingStartedVS
|
|
FAQ
|
|
yaml2obj
|
|
MarkdownQuickstartTemplate
|
|
Phabricator
|
|
Passes
|
|
YamlIO
|
|
GetElementPtr
|
|
Frontend/PerformanceTips
|
|
MCJITDesignAndImplementation
|
|
ORCv2
|
|
CodeOfConduct
|
|
CompileCudaWithLLVM
|
|
ReportingGuide
|
|
Benchmarking
|
|
Docker
|
|
BuildingADistribution
|
|
Remarks
|
|
|
|
:doc:`CMake`
|
|
An addendum to the main Getting Started guide for those using the `CMake
|
|
build system <http://www.cmake.org>`_.
|
|
|
|
:doc:`HowToBuildOnARM`
|
|
Notes on building and testing LLVM/Clang on ARM.
|
|
|
|
:doc:`HowToBuildWithPGO`
|
|
Notes on building LLVM/Clang with PGO.
|
|
|
|
:doc:`HowToCrossCompileBuiltinsOnArm`
|
|
Notes on cross-building and testing the compiler-rt builtins for Arm.
|
|
|
|
:doc:`HowToCrossCompileLLVM`
|
|
Notes on cross-building and testing LLVM/Clang.
|
|
|
|
:doc:`GettingStartedVS`
|
|
An addendum to the main Getting Started guide for those using Visual Studio
|
|
on Windows.
|
|
|
|
:doc:`Passes`
|
|
A list of optimizations and analyses implemented in LLVM.
|
|
|
|
:doc:`FAQ`
|
|
A list of common questions and problems and their solutions.
|
|
|
|
:doc:`TestSuiteGuide`
|
|
Describes how to compile and run the test-suite benchmarks.
|
|
|
|
`How to build the C, C++, ObjC, and ObjC++ front end`__
|
|
Instructions for building the clang front-end from source.
|
|
|
|
.. __: http://clang.llvm.org/get_started.html
|
|
|
|
:doc:`YamlIO`
|
|
A reference guide for using LLVM's YAML I/O library.
|
|
|
|
:doc:`GetElementPtr`
|
|
Answers to some very frequent questions about LLVM's most frequently
|
|
misunderstood instruction.
|
|
|
|
:doc:`Frontend/PerformanceTips`
|
|
A collection of tips for frontend authors on how to generate IR
|
|
which LLVM is able to effectively optimize.
|
|
|
|
:doc:`Docker`
|
|
A reference for using Dockerfiles provided with LLVM.
|
|
|
|
:doc:`BuildingADistribution`
|
|
A best-practices guide for using LLVM's CMake build system to package and
|
|
distribute LLVM-based tools.
|
|
|
|
:doc:`Remarks`
|
|
A reference on the implementation of remarks in LLVM. |