[PATCH] D106235: Reformulate OrcJIT tutorial doc to make it more clear.

[Mehdi AMINI via Phabricator via llvm-commits]

mehdi_amini added inline comments.


================
Comment at: llvm/docs/tutorial/BuildingAJIT2.rst:232
+stores it in the target ``JITDylib``, arranging for it to be passed back to 
+layer's emit method when someone requests any symbols defined by the module. Each layer 
+can complete own work by calling the ``emit`` method of its base layer. 
----------------
Nit: there is a trailing space here.


================
Comment at: llvm/docs/tutorial/BuildingAJIT2.rst:233
+layer's emit method when someone requests any symbols defined by the module. Each layer 
+can complete own work by calling the ``emit`` method of its base layer. 
+For example, in this tutorial our IRTransformLayer calls through to
----------------
"Each layer can complete **its** own work ..." ?


================
Comment at: llvm/docs/tutorial/BuildingAJIT2.rst:240
+
+
+So far we have learned how to optimize and compile our LLVM IR, but we have
----------------
I think these two added new lines aren't needed, are they?


================
Comment at: llvm/docs/tutorial/BuildingAJIT2.rst:244
+ compiles each function as soon as it is referenced by any other code, 
+ regardless of whether it is ever called at runtime. In the next chapter we
+will introduce a fully lazy compilation, in which functions are not compiled until 
----------------
Nit: You have some initial empty space at the beginning of these lines apparently


================
Comment at: llvm/docs/tutorial/BuildingAJIT2.rst:250
 functions. If we only code-gen lazily, but optimize eagerly, we will have a
-longer startup time (as everything is optimized) but relatively short pauses as
+longer startup time (as everything is optimized at that time) but relatively short pauses as
 each function just passes through code-gen. If we both optimize and code-gen
----------------
Probably should reflow here to preserve the 80cols


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D106235