[Doc][NFC] Fix Kaleidoscope links, typos and add blog posts for MCJIT

[xgupta]

Summary

To build toy.cpp we need ORCJIT instead of MCJIT library. Some links are broken by having .html extension instead of .rst. CFG image' merge block in fifth chapter return %iftmp instead of %0 (Tested on llvm-12.0git).
Provide three blog post links for Examples/MCJIT directory. (Though MCJIT examples are unmaintained/outdated so MCJIT/../toy.cpp are not building).

[fhahn]

@lhames could you take a quick look at the orcjit related changes?

llvm/docs/tutorial/LangImpl01.rst

7

This won't work I think, because this will treat it as external link.

I think you can use the :doc: directive to reference internal pages, like

:doc:`MyFirstLanguageFrontend/index

llvm/docs/tutorial/MyFirstLanguageFrontend/LangImpl05.rst

359

While you are here, we could just update those links to use internal references. Something like the code below should do it.

:ref:`requires all basic blocks to be "terminated" <functionstructure>`

and

:ref:`control flow instruction <terminators>`

[fhahn]

Thank you very much for working on improving the docs!

[xgupta]

Update to address comments.

Don't know why 'arc patch D92588' doesn't successful because of cfg image and gives an error "error: the patch applies to 'llvm/docs/tutorial/MyFirstLanguageFrontend/LangImpl05-cfg.png' (cdba92ff6c5c95b142bd928971bcdd560117028c), which does not match the current contents"? (image is now removed).

[lhames]

@fhahn @xgupta Apologies for the delayed reply. I'm not sure why this was abandoned -- it looks good to me.

[xgupta]

Thanks, @lhames for reviewing! If it is fine please commit on my behalf, I don't have commit access. ( email address- [e-mail] & githubid- xgupta)
I abandon the review at that time because I am not an active dev to work on changes if proposed.

[xgupta]

committed by https://reviews.llvm.org/rG3546b372219db5c5f4004da6a0066bb9860d3d37.

llvm/docs/tutorial/LangImpl01.rst

 Kaleidoscope Tutorial
 =====================
 
-The Kaleidoscope Tutorial has `moved to another location <MyFirstLanguageFrontend/index.html>`_ .
+The Kaleidoscope Tutorial has moved to :doc:`MyFirstLanguageFrontend/index`.

llvm/docs/tutorial/LangImpl02.rst

 Kaleidoscope Tutorial
 =====================
 
-The Kaleidoscope Tutorial has `moved to another location <MyFirstLanguageFrontend/index.html>`_ .
+The Kaleidoscope Tutorial has moved to :doc:`MyFirstLanguageFrontend/index`.

llvm/docs/tutorial/LangImpl03.rst

 Kaleidoscope Tutorial
 =====================
 
-The Kaleidoscope Tutorial has `moved to another location <MyFirstLanguageFrontend/index.html>`_ .
+The Kaleidoscope Tutorial has moved to :doc:`MyFirstLanguageFrontend/index`.

llvm/docs/tutorial/LangImpl04.rst

 Kaleidoscope Tutorial
 =====================
 
-The Kaleidoscope Tutorial has `moved to another location <MyFirstLanguageFrontend/index.html>`_ .
+The Kaleidoscope Tutorial has moved to :doc:`MyFirstLanguageFrontend/index`.

llvm/docs/tutorial/LangImpl05.rst

 Kaleidoscope Tutorial
 =====================
 
-The Kaleidoscope Tutorial has `moved to another location <MyFirstLanguageFrontend/index.html>`_ .
+The Kaleidoscope Tutorial has moved to :doc:`MyFirstLanguageFrontend/index`.

llvm/docs/tutorial/LangImpl06.rst

 Kaleidoscope Tutorial
 =====================
 
-The Kaleidoscope Tutorial has `moved to another location <MyFirstLanguageFrontend/index.html>`_ .
+The Kaleidoscope Tutorial has moved to :doc:`MyFirstLanguageFrontend/index`.

llvm/docs/tutorial/LangImpl07.rst

 Kaleidoscope Tutorial
 =====================
 
-The Kaleidoscope Tutorial has `moved to another location <MyFirstLanguageFrontend/index.html>`_ .
+The Kaleidoscope Tutorial has moved to :doc:`MyFirstLanguageFrontend/index`.

llvm/docs/tutorial/LangImpl08.rst

 Kaleidoscope Tutorial
 =====================
 
-The Kaleidoscope Tutorial has `moved to another location <MyFirstLanguageFrontend/index.html>`_ .
+The Kaleidoscope Tutorial has moved to :doc:`MyFirstLanguageFrontend/index`.

llvm/docs/tutorial/LangImpl09.rst

 Kaleidoscope Tutorial
 =====================
 
-The Kaleidoscope Tutorial has `moved to another location <MyFirstLanguageFrontend/index.html>`_ .
+The Kaleidoscope Tutorial has moved to :doc:`MyFirstLanguageFrontend/index`.

llvm/docs/tutorial/LangImpl10.rst

 Kaleidoscope Tutorial
 =====================
 
-The Kaleidoscope Tutorial has `moved to another location <MyFirstLanguageFrontend/index.html>`_ .
+The Kaleidoscope Tutorial has moved to :doc:`MyFirstLanguageFrontend/index`.

llvm/docs/tutorial/MyFirstLanguageFrontend/LangImpl04.rst

 .. code-block:: bash
 
     # Compile
-    clang++ -g toy.cpp `llvm-config --cxxflags --ldflags --system-libs --libs core mcjit native` -O3 -o toy
+    clang++ -g toy.cpp `llvm-config --cxxflags --ldflags --system-libs --libs core orcjit native` -O3 -o toy
     # Run
     ./toy
 

llvm/docs/tutorial/MyFirstLanguageFrontend/LangImpl05.rst

 Once the insertion point is set, we recursively codegen the "then"
 expression from the AST. To finish off the "then" block, we create an
 unconditional branch to the merge block. One interesting (and very
-important) aspect of the LLVM IR is that it `requires all basic blocks
-to be "terminated" <../LangRef.html#functionstructure>`_ with a `control
-flow instruction <../LangRef.html#terminators>`_ such as return or
-branch. This means that all control flow, *including fall throughs* must
-be made explicit in the LLVM IR. If you violate this rule, the verifier
-will emit an error.
+important) aspect of the LLVM IR is that it :ref:`requires all basic 
+blocks to be "terminated" <functionstructure>` with a :ref:`control 
+flow instruction <terminators>`  such as return or branch. This means 
+that all control flow, *including fall throughs* must be made explicit 
+in the LLVM IR. If you violate this rule, the verifier will emit an 
+error.
 
 The final line here is quite subtle, but is very important. The basic
 issue is that when we create the Phi node in the merge block, we need to

 .. code-block:: bash
 
     # Compile
-    clang++ -g toy.cpp `llvm-config --cxxflags --ldflags --system-libs --libs core mcjit native` -O3 -o toy
+    clang++ -g toy.cpp `llvm-config --cxxflags --ldflags --system-libs --libs core orcjit native` -O3 -o toy
     # Run
     ./toy
 

llvm/docs/tutorial/MyFirstLanguageFrontend/LangImpl06.rst

 .. code-block:: bash
 
     # Compile
-    clang++ -g toy.cpp `llvm-config --cxxflags --ldflags --system-libs --libs core mcjit native` -O3 -o toy
+    clang++ -g toy.cpp `llvm-config --cxxflags --ldflags --system-libs --libs core orcjit native` -O3 -o toy
     # Run
     ./toy
 

llvm/docs/tutorial/MyFirstLanguageFrontend/LangImpl07.rst

 .. code-block:: bash
 
     # Compile
-    clang++ -g toy.cpp `llvm-config --cxxflags --ldflags --system-libs --libs core mcjit native` -O3 -o toy
+    clang++ -g toy.cpp `llvm-config --cxxflags --ldflags --system-libs --libs core orcjit native` -O3 -o toy
     # Run
     ./toy
 

llvm/docs/tutorial/MyFirstLanguageFrontend/LangImpl09.rst

 .. code-block:: bash
 
     # Compile
-    clang++ -g toy.cpp `llvm-config --cxxflags --ldflags --system-libs --libs core mcjit native` -O3 -o toy
+    clang++ -g toy.cpp `llvm-config --cxxflags --ldflags --system-libs --libs core orcjit native` -O3 -o toy
     # Run
     ./toy
 

llvm/examples/Kaleidoscope/MCJIT/README.txt

 //                          Kaleidoscope with MCJIT
 //===----------------------------------------------------------------------===//
 
-The files in this directory are meant to accompany a series of blog posts
-that describe the process of porting the Kaleidoscope tutorial to use the MCJIT
-execution engine instead of the older JIT engine.
+The files in this directory are accompany a series of blog posts that describe 
+the process of porting the Kaleidoscope tutorial to use the MCJIT execution 
+engine instead of the older JIT engine.
 
-When the blog posts are ready this file will be updated with links to the posts.
 
-These directories contain Makefiles that allow the code to be built in a
-standalone manner, independent of the larger LLVM build infrastructure.
 

llvm/examples/Kaleidoscope/MCJIT/cached/README.txt

 //                          Kaleidoscope with MCJIT
 //===----------------------------------------------------------------------===//
 
-The files in this directory are meant to accompany the first in a series of
+The files in this directory are meant to accompany the third blog in a series of
 three blog posts that describe the process of porting the Kaleidoscope tutorial
 to use the MCJIT execution engine instead of the older JIT engine.
 
-When the blog post is ready this file will be updated with a link to the post.
+The link of blog post-
+https://blog.llvm.org/posts/2013-08-02-object-caching-with-kaleidoscope/
 
 The source code in this directory demonstrates the third version of the
 program, now modified to accept an input IR file on the command line and,

 The toy-jit.cpp file contains a version of the original JIT-based source code
 that has been modified to support the input IR file command line option.
 
-This directory contain a Makefile that allow the code to be built in a
-standalone manner, independent of the larger LLVM build infrastructure. To build
-the program you will need to have 'clang++' and 'llvm-config' in your path. If
-you attempt to build using the LLVM 3.3 release, some minor modifications will
-be required.
+To build the program you will need to have 'clang++' and 'llvm-config' in your 
+path. If you attempt to build using the LLVM 3.3 release, some minor 
+modifications will be required.
 
 This directory also contains a Python script that may be used to generate random
 input for the program and test scripts to capture data for rough performance
 comparisons.  Another Python script will split generated input files into
 definitions and function calls for the purpose of testing the IR input and
-caching facilities.
+caching facilities.
 

llvm/examples/Kaleidoscope/MCJIT/complete/README.txt

 three blog posts that describe the process of porting the Kaleidoscope tutorial
 to use the MCJIT execution engine instead of the older JIT engine.
 
-When the blog post is ready this file will be updated with a link to the post.
-
 The source code in this directory combines all previous versions, including the
 old JIT-based implementation, into a single file for easy comparison with
 command line options to select between the various possibilities.
 
-This directory contain a Makefile that allow the code to be built in a
-standalone manner, independent of the larger LLVM build infrastructure. To build
-the program you will need to have 'clang++' and 'llvm-config' in your path. If
-you attempt to build using the LLVM 3.3 release, some minor modifications will
-be required.
+To build the program you will need to have 'clang++' and 'llvm-config' in your 
+path. If you attempt to build using the LLVM 3.3 release, some minor 
+modifications will be required.
 
 This directory also contains a Python script that may be used to generate random
 input for the program and test scripts to capture data for rough performance
 comparisons.  Another Python script will split generated input files into
 definitions and function calls for the purpose of testing the IR input and
-caching facilities.
+caching facilities.
 

llvm/examples/Kaleidoscope/MCJIT/initial/README.txt

 //                          Kaleidoscope with MCJIT
 //===----------------------------------------------------------------------===//
 
-The files in this directory are meant to accompany the first in a series of
+The files in this directory are meant to accompany the first blog in a series of
 three blog posts that describe the process of porting the Kaleidoscope tutorial
 to use the MCJIT execution engine instead of the older JIT engine.
 
-When the blog post is ready this file will be updated with a link to the post.
+The link of blog post-
+https://blog.llvm.org/posts/2013-07-22-using-mcjit-with-kaleidoscope-tutorial/
 
 The source code in this directory demonstrates the initial working version of
 the program before subsequent performance improvements are applied.
 
-This directory contain a Makefile that allow the code to be built in a
-standalone manner, independent of the larger LLVM build infrastructure. To build
-the program you will need to have 'clang++' and 'llvm-config' in your path. If
-you attempt to build using the LLVM 3.3 release, some minor modifications will
-be required, as mentioned in the blog posts.
+To build the program you will need to have 'clang++' and 'llvm-config' in your 
+path. If you attempt to build using the LLVM 3.3 release, some minor 
+modifications will be required, as mentioned in the blog posts.
 

llvm/examples/Kaleidoscope/MCJIT/lazy/README.txt

 //                          Kaleidoscope with MCJIT
 //===----------------------------------------------------------------------===//
 
-The files in this directory are meant to accompany the first in a series of
+The files in this directory are meant to accompany the second blog in a series of
 three blog posts that describe the process of porting the Kaleidoscope tutorial
 to use the MCJIT execution engine instead of the older JIT engine.
 
-When the blog post is ready this file will be updated with a link to the post.
+The link of blog post-
+https://blog.llvm.org/posts/2013-07-29-kaleidoscope-performance-with-mcjit/
 
 The source code in this directory demonstrates the second version of the
 program, now modified to implement a sort of 'lazy' compilation.

 The toy-jit.cpp file contains a version of the original JIT-based source code
 that has been modified to disable most stderr output for timing purposes.
 
-This directory contain a Makefile that allow the code to be built in a
-standalone manner, independent of the larger LLVM build infrastructure. To build
-the program you will need to have 'clang++' and 'llvm-config' in your path. If
-you attempt to build using the LLVM 3.3 release, some minor modifications will
-be required.
+To build the program you will need to have 'clang++' and 'llvm-config' in your 
+path. If you attempt to build using the LLVM 3.3 release, some minor 
+modifications will be required.
 
 This directory also contains a Python script that may be used to generate random
 input for the program and test scripts to capture data for rough performance
-comparisons.
+comparisons.