maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/llvm/docs/tutorial/index.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

53 lines
1.3 KiB
ReStructuredText
Raw Normal View History

docs: Sphinxify `docs/tutorial/` Sorry for the massive commit, but I just wanted to knock this one down and it is really straightforward. There are still a couple trivial (i.e. not related to the content) things left to fix: - Use of raw HTML links where :doc:`...` and :ref:`...` could be used instead. If you are a newbie and want to help fix this it would make for some good bite-sized patches; more experienced developers should be focusing on adding new content (to this tutorial or elsewhere, but please _do not_ waste your time on formatting when there is such dire need for documentation (see docs/SphinxQuickstartTemplate.rst to get started writing)). - Highlighting of the kaleidoscope code blocks (currently left as bare `::`). I will be working on writing a custom Pygments highlighter for this, mostly as training for maintaining the `llvm` code-block's lexer in-tree. I want to do this because I am extremely unhappy with how it just "gives up" on the slightest deviation from the expected syntax and leaves the whole code-block un-highlighted. More generally I am looking at writing some Sphinx extensions and keeping them in-tree as well, to support common use cases that currently have no good solution (like "monospace text inside a link"). llvm-svn: 169343
2012-12-05 08:26:32 +08:00
================================
docs: Begin Sphinxification of docs/tutorial/ llvm-svn: 169309
2012-12-05 05:16:41 +08:00
LLVM Tutorial: Table of Contents
================================
docs: Sphinxify `docs/tutorial/` Sorry for the massive commit, but I just wanted to knock this one down and it is really straightforward. There are still a couple trivial (i.e. not related to the content) things left to fix: - Use of raw HTML links where :doc:`...` and :ref:`...` could be used instead. If you are a newbie and want to help fix this it would make for some good bite-sized patches; more experienced developers should be focusing on adding new content (to this tutorial or elsewhere, but please _do not_ waste your time on formatting when there is such dire need for documentation (see docs/SphinxQuickstartTemplate.rst to get started writing)). - Highlighting of the kaleidoscope code blocks (currently left as bare `::`). I will be working on writing a custom Pygments highlighter for this, mostly as training for maintaining the `llvm` code-block's lexer in-tree. I want to do this because I am extremely unhappy with how it just "gives up" on the slightest deviation from the expected syntax and leaves the whole code-block un-highlighted. More generally I am looking at writing some Sphinx extensions and keeping them in-tree as well, to support common use cases that currently have no good solution (like "monospace text inside a link"). llvm-svn: 169343
2012-12-05 08:26:32 +08:00
Kaleidoscope: Implementing a Language with LLVM
===============================================
.. toctree::
[Docs] Try fixing the tutorial toctree Unorphan the old tutorial and reference every page in the index explicitly. This should hopefully make Sphinx generate correct hyperlinks now.
2019-11-17 07:06:50 +08:00
:hidden:
docs: Begin Sphinxification of docs/tutorial/ llvm-svn: 169309
2012-12-05 05:16:41 +08:00
[docs] Fix sphinx doc generation errors Summary: Errors fixed: - GettingStarted: Duplicate explicit target name: "cmake" - GlobalISel: Unexpected indentation - LoopTerminology: Explicit markup ends without a blank line; unexpected unindent - ORCv2: Definition list ends without a blank line; unexpected unindent - Misc: document isn't included in any toctree Verified that a clean docs build (`rm -rf docs/ && ninja docs-llvm-html`) passes with no errors. Spot checked the individual pages to make sure they look OK. Reviewers: thakis, dsanders Reviewed By: dsanders Subscribers: arphaman, llvm-commits, lhames, rovka, dsanders, reames Tags: #llvm Differential Revision: https://reviews.llvm.org/D66183 llvm-svn: 368932
2019-08-15 06:18:01 +08:00
MyFirstLanguageFrontend/index
[Docs] Try fixing the tutorial toctree Unorphan the old tutorial and reference every page in the index explicitly. This should hopefully make Sphinx generate correct hyperlinks now.
2019-11-17 07:06:50 +08:00
:doc:`MyFirstLanguageFrontend/index`
This is the "Kaleidoscope" Language tutorial, showing how to implement a simple
language using LLVM components in C++.
docs: Begin Sphinxification of docs/tutorial/ llvm-svn: 169309
2012-12-05 05:16:41 +08:00
docs: Sphinxify `docs/tutorial/` Sorry for the massive commit, but I just wanted to knock this one down and it is really straightforward. There are still a couple trivial (i.e. not related to the content) things left to fix: - Use of raw HTML links where :doc:`...` and :ref:`...` could be used instead. If you are a newbie and want to help fix this it would make for some good bite-sized patches; more experienced developers should be focusing on adding new content (to this tutorial or elsewhere, but please _do not_ waste your time on formatting when there is such dire need for documentation (see docs/SphinxQuickstartTemplate.rst to get started writing)). - Highlighting of the kaleidoscope code blocks (currently left as bare `::`). I will be working on writing a custom Pygments highlighter for this, mostly as training for maintaining the `llvm` code-block's lexer in-tree. I want to do this because I am extremely unhappy with how it just "gives up" on the slightest deviation from the expected syntax and leaves the whole code-block un-highlighted. More generally I am looking at writing some Sphinx extensions and keeping them in-tree as well, to support common use cases that currently have no good solution (like "monospace text inside a link"). llvm-svn: 169343
2012-12-05 08:26:32 +08:00
.. toctree::
:titlesonly:
:glob:
:numbered:
docs: Begin Sphinxification of docs/tutorial/ llvm-svn: 169309
2012-12-05 05:16:41 +08:00
[Draft] [examples] Move llvm/examples/OCaml-Kaleidoscope/ to llvm-archive
2021-02-09 06:50:02 +08:00
MyFirstLanguageFrontend/LangImpl*
docs: Begin Sphinxification of docs/tutorial/ llvm-svn: 169309
2012-12-05 05:16:41 +08:00
[Kaleidoscope][BuildingAJIT] Shorten the name of the BuildingAJIT tutorial series. The original name was pretty long, and likely to look awkward as more chapters get added. llvm-svn: 270796
2016-05-26 07:34:19 +08:00
Building a JIT in LLVM
[Kaleidoscope] Add an initial "Building an ORC JIT" tutorial chapter. This is a work in progress - the chapter text is incomplete, though the example code compiles and runs. Feedback and patches are, as usual, most welcome. llvm-svn: 270487
2016-05-24 04:34:19 +08:00
===============================================
.. toctree::
:titlesonly:
:glob:
:numbered:
BuildingAJIT*
docs: Add link to external LLVM backend tutorial. llvm-svn: 170998
2012-12-23 15:34:51 +08:00
External Tutorials
==================
[docs]LLVM Tutorial: fix the typo in Cpu0 URL jonathan2251.github.com/lbd/ is 404. Update the URL to .io one according to https://github.com/Jonathan2251/lbd/blob/master/README.md.
2021-12-21 05:45:51 +08:00
`Tutorial: Creating an LLVM Backend for the Cpu0 Architecture <http://jonathan2251.github.io/lbd/>`_
docs: Add link to external LLVM backend tutorial. llvm-svn: 170998
2012-12-23 15:34:51 +08:00
A step-by-step tutorial for developing an LLVM backend. Under
active development at `<https://github.com/Jonathan2251/lbd>`_ (please
contribute!).
docs: Move link to the new "external tutorials" area. llvm-svn: 171154
2012-12-27 16:57:08 +08:00
`Howto: Implementing LLVM Integrated Assembler`_
A simple guide for how to implement an LLVM integrated assembler for an
architecture.
[docs] Fix broken link. llvm-svn: 184514
2013-06-21 09:11:52 +08:00
.. _`Howto: Implementing LLVM Integrated Assembler`: http://www.embecosm.com/appnotes/ean10/ean10-howto-llvmas-1.0.html
docs: Begin Sphinxification of docs/tutorial/ llvm-svn: 169309
2012-12-05 05:16:41 +08:00
docs: Sphinxify `docs/tutorial/` Sorry for the massive commit, but I just wanted to knock this one down and it is really straightforward. There are still a couple trivial (i.e. not related to the content) things left to fix: - Use of raw HTML links where :doc:`...` and :ref:`...` could be used instead. If you are a newbie and want to help fix this it would make for some good bite-sized patches; more experienced developers should be focusing on adding new content (to this tutorial or elsewhere, but please _do not_ waste your time on formatting when there is such dire need for documentation (see docs/SphinxQuickstartTemplate.rst to get started writing)). - Highlighting of the kaleidoscope code blocks (currently left as bare `::`). I will be working on writing a custom Pygments highlighter for this, mostly as training for maintaining the `llvm` code-block's lexer in-tree. I want to do this because I am extremely unhappy with how it just "gives up" on the slightest deviation from the expected syntax and leaves the whole code-block un-highlighted. More generally I am looking at writing some Sphinx extensions and keeping them in-tree as well, to support common use cases that currently have no good solution (like "monospace text inside a link"). llvm-svn: 169343
2012-12-05 08:26:32 +08:00
Advanced Topics
===============
docs: Begin Sphinxification of docs/tutorial/ llvm-svn: 169309
2012-12-05 05:16:41 +08:00
Doc: Links should use https
2020-03-23 05:42:03 +08:00
#. `Writing an Optimization for LLVM <https://llvm.org/pubs/2004-09-22-LCPCLLVMTutorial.html>`_
docs: Begin Sphinxification of docs/tutorial/ llvm-svn: 169309
2012-12-05 05:16:41 +08:00