[PATCH] D101284: [docs] Update the llvm/example section

Shivam Gupta via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Wed May 5 09:04:11 PDT 2021


This revision was landed with ongoing or failed builds.
This revision was automatically updated to reflect the committed changes.
Closed by commit rG0b9447157b01: [docs] Update the llvm/example section (authored by pooja2299, committed by xgupta).

Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D101284/new/

https://reviews.llvm.org/D101284

Files:
  llvm/docs/GettingStarted.rst


Index: llvm/docs/GettingStarted.rst
===================================================================
--- llvm/docs/GettingStarted.rst
+++ llvm/docs/GettingStarted.rst
@@ -817,7 +817,21 @@
 ``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``
 ----------------


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D101284.343070.patch
Type: text/x-patch
Size: 1209 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20210505/74030aca/attachment.bin>


More information about the llvm-commits mailing list