diff options
| author | DeForest Richards <d4m1887@gmail.com> | 2019-09-27 19:12:00 +0000 |
|---|---|---|
| committer | DeForest Richards <d4m1887@gmail.com> | 2019-09-27 19:12:00 +0000 |
| commit | 2605f8c4616e6c40d6d5d3fecdde1a9b4253719a (patch) | |
| tree | 603e4cff5d3e5a01319e6567aa3ea5f4f63430bd | |
| parent | 9a39e7f0a38607d444dc1389bd8268a950d6d737 (diff) | |
| download | bcm5719-llvm-2605f8c4616e6c40d6d5d3fecdde1a9b4253719a.tar.gz bcm5719-llvm-2605f8c4616e6c40d6d5d3fecdde1a9b4253719a.zip | |
[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
| -rw-r--r-- | llvm/docs/UserGuides.rst | 51 |
1 files changed, 36 insertions, 15 deletions
diff --git a/llvm/docs/UserGuides.rst b/llvm/docs/UserGuides.rst index 9dfab67f42e..d75769a7938 100644 --- a/llvm/docs/UserGuides.rst +++ b/llvm/docs/UserGuides.rst @@ -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.
\ No newline at end of file |
