RPCS3/llvm
1
0
Fork 0
mirror of https://github.com/RPCS3/llvm.git synced 2025-02-25 21:33:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[Docs] Adds new section to User Guides page

Browse Source 
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.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@373113 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
DeForest Richards 2019-09-27 19:12:00 +00:00
parent 86c4c0a3e2
commit 7d456cf705
1 changed files with 36 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
docs/UserGuides.rst
View File

@ -35,33 +35,61 @@ intermediate LLVM representation.
BuildingADistribution
Remarks
Building, Packaging, and Distributing LLVM
------------------------------------------
How to build, package, and distribute LLVM.
=====
CMake
=====
: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>`_.
=====
Clang
=====
: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.
`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
======
Docker
======
:doc:`Docker`
A reference for using Dockerfiles provided with LLVM.
=================
Additional Topics
=================
:doc:`HowToCrossCompileBuiltinsOnArm`
Notes on cross-building and testing the compiler-rt builtins for Arm.
:doc:`Passes`
A list of optimizations and analyses implemented in LLVM.
: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.
@ -73,12 +101,5 @@ intermediate LLVM representation.
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.