]> granicus.if.org Git - llvm/commitdiff
[Docs] Adds new section to User Guides page
authorDeForest Richards <d4m1887@gmail.com>
Fri, 27 Sep 2019 19:12:00 +0000 (19:12 +0000)
committerDeForest Richards <d4m1887@gmail.com>
Fri, 27 Sep 2019 19:12:00 +0000 (19:12 +0000)
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

docs/UserGuides.rst

index 9dfab67f42eb3411e2f2f18b9f98d513835721de..d75769a793899c2a4799d633dae20736de6525b0 100644 (file)
@@ -35,33 +35,61 @@ intermediate LLVM representation.
    BuildingADistribution\r
    Remarks\r
 \r
+Building, Packaging, and Distributing LLVM\r
+------------------------------------------\r
+\r
+How to build, package, and distribute LLVM.\r
+\r
+=====\r
+CMake\r
+=====\r
+\r
+:doc:`BuildingADistribution`\r
+  A best-practices guide for using LLVM's CMake build system to package and\r
+  distribute LLVM-based tools.\r
+\r
 :doc:`CMake`\r
    An addendum to the main Getting Started guide for those using the `CMake\r
    build system <http://www.cmake.org>`_.\r
 \r
+=====\r
+Clang\r
+=====\r
+\r
 :doc:`HowToBuildOnARM`\r
    Notes on building and testing LLVM/Clang on ARM.\r
 \r
 :doc:`HowToBuildWithPGO`\r
     Notes on building LLVM/Clang with PGO.\r
 \r
-:doc:`HowToCrossCompileBuiltinsOnArm`\r
-   Notes on cross-building and testing the compiler-rt builtins for Arm.\r
-\r
 :doc:`HowToCrossCompileLLVM`\r
    Notes on cross-building and testing LLVM/Clang.\r
 \r
+`How to build the C, C++, ObjC, and ObjC++ front end`__\r
+   Instructions for building the clang front-end from source.\r
+\r
+   .. __: http://clang.llvm.org/get_started.html\r
+\r
+======\r
+Docker\r
+======\r
+\r
+:doc:`Docker`\r
+   A reference for using Dockerfiles provided with LLVM.\r
+\r
+=================\r
+Additional Topics\r
+=================\r
+\r
+:doc:`HowToCrossCompileBuiltinsOnArm`\r
+   Notes on cross-building and testing the compiler-rt builtins for Arm.\r
+\r
 :doc:`Passes`\r
    A list of optimizations and analyses implemented in LLVM.\r
 \r
 :doc:`TestSuiteGuide`\r
   Describes how to compile and run the test-suite benchmarks.\r
 \r
-`How to build the C, C++, ObjC, and ObjC++ front end`__\r
-   Instructions for building the clang front-end from source.\r
-\r
-   .. __: http://clang.llvm.org/get_started.html\r
-\r
 :doc:`YamlIO`\r
    A reference guide for using LLVM's YAML I/O library.\r
 \r
@@ -73,12 +101,5 @@ intermediate LLVM representation.
    A collection of tips for frontend authors on how to generate IR\r
    which LLVM is able to effectively optimize.\r
 \r
-:doc:`Docker`\r
-   A reference for using Dockerfiles provided with LLVM.\r
-\r
-:doc:`BuildingADistribution`\r
-  A best-practices guide for using LLVM's CMake build system to package and\r
-  distribute LLVM-based tools.\r
-\r
 :doc:`Remarks`\r
    A reference on the implementation of remarks in LLVM.
\ No newline at end of file