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

Philip Reames via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Wed Apr 28 11:52:35 PDT 2021


reames added a comment.

Minor optional suggestions, but LGTM to me too.

@xgupta - I suggest avoiding both LGTMing and asking for another reviewer.  Given LLVM is a single accept culture, this can be really confusing to new contributors.  I suggest wording along the lines of "This seems good to me, but I'd like a second opinion before LGTMing.  Maybe X and Y can confirm?"  Alternatively, you could simply LGTM if you were comfortable with that.  Another phrasing might be "LGTM, but please wait N days before submitting in case X or Y have additional comments".



================
Comment at: llvm/docs/GettingStarted.rst:820
 
-Simple examples using the LLVM IR and JIT.
+- Some simple examples showing how to use the LLVM IR, JIT, LLJIT, ORCv2, 
+  ParallelJIT, IR Transforms and SpeculativeJIT.
----------------
The last part of this sentence gets a bit complicated, can I suggest:

Some simple examples showing how to use LLVM as a compiler for a custom language - including lowering, optimization, and code generation.


================
Comment at: llvm/docs/GettingStarted.rst:826
+  including a hand-written lexer, parser, AST, as well as code generation 
+  support using LLVM- both static and JIT! 
+  `Kaleidoscope Tutorial for complete beginner 
----------------
Maybe replace "both static and JIT" with " both static (ahead of time) and various approaches to Just In Time (JIT) compilation."


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D101284



More information about the llvm-commits mailing list