summaryrefslogtreecommitdiffstats
path: root/llvm/docs/tutorial
diff options
context:
space:
mode:
authorLang Hames <lhames@gmail.com>2018-02-06 21:25:20 +0000
committerLang Hames <lhames@gmail.com>2018-02-06 21:25:20 +0000
commitf3fb98365d6b2ac8fe0e10799acf1a111ca37f6f (patch)
treeef65210a9e8af02537e40ab1da6d649ed47f873d /llvm/docs/tutorial
parent4b546c91452c5735ada1430f8a6943328e4dba4e (diff)
downloadbcm5719-llvm-f3fb98365d6b2ac8fe0e10799acf1a111ca37f6f.tar.gz
bcm5719-llvm-f3fb98365d6b2ac8fe0e10799acf1a111ca37f6f.zip
[docs] Add out-of-date warnings to the BuildingAJIT tutorial text.
The text will be updated once the ORC API churn dies down. llvm-svn: 324406
Diffstat (limited to 'llvm/docs/tutorial')
-rw-r--r--llvm/docs/tutorial/BuildingAJIT1.rst5
-rw-r--r--llvm/docs/tutorial/BuildingAJIT2.rst5
-rw-r--r--llvm/docs/tutorial/BuildingAJIT3.rst5
3 files changed, 15 insertions, 0 deletions
diff --git a/llvm/docs/tutorial/BuildingAJIT1.rst b/llvm/docs/tutorial/BuildingAJIT1.rst
index 9d7f5047783..2b83df42fc2 100644
--- a/llvm/docs/tutorial/BuildingAJIT1.rst
+++ b/llvm/docs/tutorial/BuildingAJIT1.rst
@@ -8,6 +8,11 @@ Building a JIT: Starting out with KaleidoscopeJIT
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
diff --git a/llvm/docs/tutorial/BuildingAJIT2.rst b/llvm/docs/tutorial/BuildingAJIT2.rst
index f1861033cc7..95d0c1a6dd5 100644
--- a/llvm/docs/tutorial/BuildingAJIT2.rst
+++ b/llvm/docs/tutorial/BuildingAJIT2.rst
@@ -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
diff --git a/llvm/docs/tutorial/BuildingAJIT3.rst b/llvm/docs/tutorial/BuildingAJIT3.rst
index 9c4e59fe117..36ec2e707a7 100644
--- a/llvm/docs/tutorial/BuildingAJIT3.rst
+++ b/llvm/docs/tutorial/BuildingAJIT3.rst
@@ -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>`_.
OpenPOWER on IntegriCloud