[llvm] r324406 - [docs] Add out-of-date warnings to the BuildingAJIT tutorial text.

Lang Hames via llvm-commits llvm-commits at lists.llvm.org
Tue Feb 6 13:25:20 PST 2018


Author: lhames
Date: Tue Feb  6 13:25:20 2018
New Revision: 324406

URL: http://llvm.org/viewvc/llvm-project?rev=324406&view=rev
Log:
[docs] Add out-of-date warnings to the BuildingAJIT tutorial text.

The text will be updated once the ORC API churn dies down.

Modified:
    llvm/trunk/docs/tutorial/BuildingAJIT1.rst
    llvm/trunk/docs/tutorial/BuildingAJIT2.rst
    llvm/trunk/docs/tutorial/BuildingAJIT3.rst

Modified: llvm/trunk/docs/tutorial/BuildingAJIT1.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/tutorial/BuildingAJIT1.rst?rev=324406&r1=324405&r2=324406&view=diff
==============================================================================
--- llvm/trunk/docs/tutorial/BuildingAJIT1.rst (original)
+++ llvm/trunk/docs/tutorial/BuildingAJIT1.rst Tue Feb  6 13:25:20 2018
@@ -8,6 +8,11 @@ Building a JIT: Starting out with Kaleid
 Chapter 1 Introduction
 ======================
 
+**Warning: This text is currently out of date due to ORC API updates.**
+
+**The example code has been updated and can be used. The text will be updated
+once the API churn dies down.**
+
 Welcome to Chapter 1 of the "Building an ORC-based JIT in LLVM" tutorial. This
 tutorial runs through the implementation of a JIT compiler using LLVM's
 On-Request-Compilation (ORC) APIs. It begins with a simplified version of the

Modified: llvm/trunk/docs/tutorial/BuildingAJIT2.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/tutorial/BuildingAJIT2.rst?rev=324406&r1=324405&r2=324406&view=diff
==============================================================================
--- llvm/trunk/docs/tutorial/BuildingAJIT2.rst (original)
+++ llvm/trunk/docs/tutorial/BuildingAJIT2.rst Tue Feb  6 13:25:20 2018
@@ -12,6 +12,11 @@ we welcome any feedback.
 Chapter 2 Introduction
 ======================
 
+**Warning: This text is currently out of date due to ORC API updates.**
+
+**The example code has been updated and can be used. The text will be updated
+once the API churn dies down.**
+
 Welcome to Chapter 2 of the "Building an ORC-based JIT in LLVM" tutorial. In
 `Chapter 1 <BuildingAJIT1.html>`_ of this series we examined a basic JIT
 class, KaleidoscopeJIT, that could take LLVM IR modules as input and produce

Modified: llvm/trunk/docs/tutorial/BuildingAJIT3.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/tutorial/BuildingAJIT3.rst?rev=324406&r1=324405&r2=324406&view=diff
==============================================================================
--- llvm/trunk/docs/tutorial/BuildingAJIT3.rst (original)
+++ llvm/trunk/docs/tutorial/BuildingAJIT3.rst Tue Feb  6 13:25:20 2018
@@ -12,6 +12,11 @@ we welcome any feedback.
 Chapter 3 Introduction
 ======================
 
+**Warning: This text is currently out of date due to ORC API updates.**
+
+**The example code has been updated and can be used. The text will be updated
+once the API churn dies down.**
+
 Welcome to Chapter 3 of the "Building an ORC-based JIT in LLVM" tutorial. This
 chapter discusses lazy JITing and shows you how to enable it by adding an ORC
 CompileOnDemand layer the JIT from `Chapter 2 <BuildingAJIT2.html>`_.




More information about the llvm-commits mailing list