From: DeForest Richards Date: Fri, 27 Sep 2019 19:12:00 +0000 (+0000) Subject: [Docs] Adds new section to User Guides page X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=7d456cf705bf9711fc6e3008a0f7e6121c799239;p=llvm [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. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@373113 91177308-0d34-0410-b5e6-96231b3b80d8 --- diff --git a/docs/UserGuides.rst b/docs/UserGuides.rst index 9dfab67f42e..d75769a7938 100644 --- a/docs/UserGuides.rst +++ b/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 `_. +===== +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