RPCS3/llvm-mirror
1
0
Fork 0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-26 04:32:44 +01:00
Code Issues Projects Releases Wiki Activity

[Docs] Try fixing the tutorial toctree

Browse Source 
Unorphan the old tutorial and reference every page in the index
explicitly. This should hopefully make Sphinx generate correct
hyperlinks now.
This commit is contained in:
kristina 2019-11-16 23:06:50 +00:00
parent f8f7f252c0
commit d7061fcc4e
12 changed files with 21 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/tutorial/MyFirstLanguageFrontend/LangImpl01.rst
View File

@ -1,5 +1,3 @@
:orphan:
=====================================================
Kaleidoscope: Kaleidoscope Introduction and the Lexer
=====================================================

2
docs/tutorial/MyFirstLanguageFrontend/LangImpl02.rst
View File

@ -1,5 +1,3 @@
:orphan:
===========================================
Kaleidoscope: Implementing a Parser and AST
===========================================

4
docs/tutorial/MyFirstLanguageFrontend/LangImpl03.rst
View File

@ -1,5 +1,3 @@
:orphan:
========================================
Kaleidoscope: Code generation to LLVM IR
========================================
@ -198,7 +196,7 @@ automatically provide each one with an increasing, unique numeric
suffix. Local value names for instructions are purely optional, but it
makes it much easier to read the IR dumps.
`LLVM instructions <../../LangRef.html#instruction-reference>`_ are constrained by strict
:doc:`LLVM instructions <LangRef>` are constrained by strict
rules: for example, the Left and Right operators of an `add
instruction <../../LangRef.html#add-instruction>`_ must have the same type, and the
result type of the add must match the operand types. Because all values

2
docs/tutorial/MyFirstLanguageFrontend/LangImpl04.rst
View File

@ -1,5 +1,3 @@
:orphan:
==============================================
Kaleidoscope: Adding JIT and Optimizer Support
==============================================

2
docs/tutorial/MyFirstLanguageFrontend/LangImpl05.rst
View File

@ -1,5 +1,3 @@
:orphan:
==================================================
Kaleidoscope: Extending the Language: Control Flow
==================================================

2
docs/tutorial/MyFirstLanguageFrontend/LangImpl06.rst
View File

@ -1,5 +1,3 @@
:orphan:
============================================================
Kaleidoscope: Extending the Language: User-defined Operators
============================================================

2
docs/tutorial/MyFirstLanguageFrontend/LangImpl07.rst
View File

@ -1,5 +1,3 @@
:orphan:
=======================================================
Kaleidoscope: Extending the Language: Mutable Variables
=======================================================

2
docs/tutorial/MyFirstLanguageFrontend/LangImpl08.rst
View File

@ -1,5 +1,3 @@
:orphan:
========================================
Kaleidoscope: Compiling to Object Code
========================================

2
docs/tutorial/MyFirstLanguageFrontend/LangImpl09.rst
View File

@ -1,5 +1,3 @@
:orphan:
======================================
Kaleidoscope: Adding Debug Information
======================================

2
docs/tutorial/MyFirstLanguageFrontend/LangImpl10.rst
View File

@ -1,5 +1,3 @@
:orphan:
======================================================
Kaleidoscope: Conclusion and other useful LLVM tidbits
======================================================

17
docs/tutorial/MyFirstLanguageFrontend/index.rst
View File

@ -2,6 +2,20 @@
My First Language Frontend with LLVM Tutorial
=============================================
.. toctree::
:hidden:
LangImpl01
LangImpl02
LangImpl03
LangImpl04
LangImpl05
LangImpl06
LangImpl07
LangImpl08
LangImpl09
LangImpl10
**Requirements:** This tutorial assumes you know C++, but no previous
compiler experience is necessary.
@ -46,7 +60,8 @@ allowing you to skip ahead as you wish:
One great thing about LLVM is its support for JIT compilation, so
we'll dive right into it and show you the 3 lines it takes to add JIT
support. Later chapters show how to generate .o files.
- `Chapter #5: Extending the Language: Control Flow <LangImpl05.html>`_ - With the basic language up and running, we show how to extend
- `Chapter #5: Extending the Language: Control Flow <LangImpl05.html>`_ - With
the basic language up and running, we show how to extend
it with control flow operations ('if' statement and a 'for' loop). This
gives us a chance to talk about SSA construction and control
flow.

5
docs/tutorial/index.rst
View File

@ -6,12 +6,11 @@ Kaleidoscope: Implementing a Language with LLVM
===============================================
.. toctree::
:titlesonly:
:glob:
:numbered:
:hidden:
MyFirstLanguageFrontend/index
:doc:`MyFirstLanguageFrontend/index`
This is the "Kaleidoscope" Language tutorial, showing how to implement a simple
language using LLVM components in C++.