[llvm] 0b94471 - [docs] Update the llvm/example section

via llvm-commits llvm-commits at lists.llvm.org
Wed May 5 09:04:07 PDT 2021


Author: Pooja Yadav
Date: 2021-05-05T21:33:14+05:30
New Revision: 0b9447157b01ac18bb9f4d865920027cbd7df840

URL: https://github.com/llvm/llvm-project/commit/0b9447157b01ac18bb9f4d865920027cbd7df840
DIFF: https://github.com/llvm/llvm-project/commit/0b9447157b01ac18bb9f4d865920027cbd7df840.diff

LOG: [docs] Update the llvm/example section

Added details about the llvm/example section.

Reviewed By: xgupta

Differential Revision: https://reviews.llvm.org/D101284

Added: 
    

Modified: 
    llvm/docs/GettingStarted.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/GettingStarted.rst b/llvm/docs/GettingStarted.rst
index 8adef851b000..478b3a363aae 100644
--- a/llvm/docs/GettingStarted.rst
+++ b/llvm/docs/GettingStarted.rst
@@ -817,7 +817,21 @@ layout:
 ``llvm/examples``
 -----------------
 
-Simple examples using the LLVM IR and JIT.
+- Some simple examples showing how to use LLVM as a compiler for a custom 
+  language - including lowering, optimization, and code generation.
+
+- Kaleidoscope Tutorial: Kaleidoscope language tutorial run through the 
+  implementation of a nice little compiler for a non-trivial language 
+  including a hand-written lexer, parser, AST, as well as code generation 
+  support using LLVM- both static (ahead of time) and various approaches to 
+  Just In Time (JIT) compilation. 
+  `Kaleidoscope Tutorial for complete beginner 
+  <https://llvm.org/docs/tutorial/MyFirstLanguageFrontend/index.html>`_.
+
+- BuildingAJIT: Examples of the `BuildingAJIT tutorial 
+  <https://llvm.org/docs/tutorial/BuildingAJIT1.html>`_ that shows how LLVM’s 
+  ORC JIT APIs interact with other parts of LLVM. It also, teaches how to 
+  recombine them to build a custom JIT that is suited to your use-case.
 
 ``llvm/include``
 ----------------


        


More information about the llvm-commits mailing list