aboutsummaryrefslogtreecommitdiff
path: root/llvm/docs/tutorial
AgeCommit message (Collapse)AuthorFilesLines
2019-09-13Fix a few spellos in docs.Nico Weber2-2/+2
(Trying to debug an incremental build thing on a bot...) llvm-svn: 371860
2019-08-15[llvm] Migrate llvm::make_unique to std::make_uniqueJonas Devlieghere8-31/+31
Now that we've moved to C++14, we no longer need the llvm::make_unique implementation from STLExtras.h. This patch is a mechanical replacement of (hopefully) all the llvm::make_unique instances across the monorepo. llvm-svn: 369013
2019-08-14[docs] Fix sphinx doc generation errorsJordan Rupprecht1-3/+4
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-05Rename F_{None,Text,Append} to OF_{None,Text,Append}. NFCFangrui Song1-1/+1
F_{None,Text,Append} are kept for compatibility since r334221. llvm-svn: 367800
2019-07-30[Docs] Fix sphinx warning in OCamlLangImpl5.rstFrancis Visoiu Mistrih1-1/+1
The path to the image was outdated. http://lab.llvm.org:8011/builders/llvm-sphinx-docs/builds/33865/steps/docs-llvm-html/logs/stdio llvm/docs/tutorial/OCamlLangImpl5.rst:173: WARNING: image file not readable: tutorial/LangImpl05-cfg.png llvm-svn: 367334
2019-07-19unbreak linksChris Lattner11-11/+11
llvm-svn: 366530
2019-07-19replace the old kaleidoscope tutorial files with orphaned pages that forward ↵Chris Lattner13-5638/+47
to the new copy. llvm-svn: 366529
2019-07-19Point to the dusted off version of the kaleidoscope tutorial.Chris Lattner2-2/+4
llvm-svn: 366528
2019-04-12Fix missing arguments in tutorialHans Wennborg1-1/+1
In tutorial "8. Kaleidoscope: Compiling to Object Code" a call to TargetMachine->addPassesToEmitFile(pass, dest, FileType) is missing nullptr as its 3rd value. Patch by Sajjad Heydari! Differential revision: https://reviews.llvm.org/D60369 llvm-svn: 358267
2019-04-11try to fix the sphinx build some moreHans Wennborg11-0/+22
llvm-svn: 358156
2019-04-11Try to fix the shpinx buildHans Wennborg9-9/+9
llvm-svn: 358154
2019-04-07last changes for nowChris Lattner1-2/+2
llvm-svn: 357868
2019-04-07various improvements in wording, also unbreak the botChris Lattner3-42/+44
llvm-svn: 357867
2019-04-07make a bunch of cleanups in wording and toneChris Lattner1-75/+52
llvm-svn: 357865
2019-04-07remove some unhelpful language from the tutorialChris Lattner2-7/+106
llvm-svn: 357863
2019-04-07Copy the C++ kaleidoscope tutorial into a subdirectory and clean up various ↵Chris Lattner11-0/+5560
things, aligning with the direction of the WiCT workshop, and Meike Baumgärtner's view of how this should work. The old version of the documentation is unmodified, this is an experiment. llvm-svn: 357862
2019-03-12[Docs] Add note about legacy PM to Ch4 of tutorialKristina Brooks1-0/+8
Add a note about legacy FunctionPassManager to the LLVM tutorial. It seems to confuse some people, worth adding a warning to the tutorial to elaborate and suggest using `llvm::legacy::FunctionPassManager` for now. Not a perfect solution but hopefully will avoid confusion in the meantime. Differential Revision: https://reviews.llvm.org/D59258 llvm-svn: 355930
2019-02-16Fixed code snippet in Kaleidoscope tutorial to reflect final full code listingWilfred Hughes1-1/+1
Patch by Frank He. Differential Revision: https://reviews.llvm.org/D52166 llvm-svn: 354205
2018-11-13[BuildingAJIT] Clang-format chapters 1 and 2.Lang Hames1-2/+2
llvm-svn: 346727
2018-11-13[BuildingAJIT] Update chapter 2 to use the ORCv2 APIs.Lang Hames1-202/+145
llvm-svn: 346726
2018-10-18[BuildingAJIT] Update the Ch1 KaleidoscopeJIT class to expose errors to clients.Lang Hames1-80/+84
Returning the error to clients provides an opportunity to introduce readers to the Expected and Error APIs and makes the tutorial more useful as a starting point for a real JIT class, while only slightly complicating the code. llvm-svn: 344720
2018-10-17[BuildingAJIT] Simplify a tutorial example and fix a syntax error.Lang Hames1-3/+2
llvm-svn: 344712
2018-10-17[BuildingAJIT] Fix a function signature in the documentation.Lang Hames1-2/+2
llvm-svn: 344705
2018-10-17[BuildingAJIT] Update chapter 1 to use the ORCv2 APIs.Lang Hames1-239/+156
llvm-svn: 344667
2018-05-08[docs] Fix a typo in KaleidoscopeJIT tutorialStephane Sezer1-1/+1
Summary: Just a missing end quote. Reviewers: lhames Subscribers: llvm-commits Differential Revision: https://reviews.llvm.org/D46136 llvm-svn: 331794
2018-04-29s/LLVM_ON_WIN32/_WIN32/, llvmNico Weber1-1/+1
LLVM_ON_WIN32 is set exactly with MSVC and MinGW (but not Cygwin) in HandleLLVMOptions.cmake, which is where _WIN32 defined too. Just use the default macro instead of a reinvented one. See thread "Replacing LLVM_ON_WIN32 with just _WIN32" on llvm-dev and cfe-dev. No intended behavior change. This moves over all uses of the macro, but doesn't remove the definition of it in (llvm-)config.h yet. llvm-svn: 331127
2018-03-29[Kaleidoscope] Tiny typo fixesSjoerd Meijer5-14/+14
Fixes for "lets" references which should be "let's" in the Kaleidoscope tutorial. Patch by: Robin Dupret Differential Revision: https://reviews.llvm.org/D44990 llvm-svn: 328772
2018-03-20[Kaleidoscope] doc fixSjoerd Meijer1-5/+5
This fixes the compile command of the example in Chapter 2. Differential Revision: https://reviews.llvm.org/D43196 llvm-svn: 327989
2018-02-06[docs] Add out-of-date warnings to the BuildingAJIT tutorial text.Lang Hames3-0/+15
The text will be updated once the ORC API churn dies down. llvm-svn: 324406
2018-01-29[NFC] fix trivial typos in comments and documentsHiroshi Inoue1-1/+1
"to to" -> "to" llvm-svn: 323628
2018-01-26[NFC] fix trivial typos in comments and documentsHiroshi Inoue1-1/+1
"in in" -> "in", "on on" -> "on" etc. llvm-svn: 323508
2018-01-16[NFC] fix trivial typos in documentsHiroshi Inoue1-1/+1
"the the" -> "the" llvm-svn: 322552
2017-12-20PR35705: Fix Chapter 9 example code for API changes to DIBuilderDavid Blaikie1-2/+3
llvm-svn: 321214
2017-09-17[ORC][Kaleidoscope] Update ORCJit tutorial.Don Hinton5-102/+101
Summary: Fix a few typos and update names to match current source. Differential Revision: https://reviews.llvm.org/D37948 llvm-svn: 313473
2017-08-15[ORC][Kaleidoscope] Update Chapter 1 of BuildingAJIT to incorporate recent ORCLang Hames1-77/+100
API changes. llvm-svn: 310947
2017-07-10[docs] NFC: Fix links in the tutorialKirill Bobyrev8-16/+16
r274441 introduced Chapter 10 of "Implementing a Language with LLVM" tutorial, which caused all files in the tutorial to start using two digit numbering. But many links were not changed and therefore appear to be broken. This patch addresses described issue. As a result, following command does not produce any output anymore: $ grep -nR '<LangImpl[0-9].html>' ./docs/tutorial/ llvm-svn: 307525
2017-03-04Remove redundant code block and update comment.Sylvestre Ledru1-13/+1
By patch zoren here: https://github.com/llvm-mirror/llvm/pull/20 llvm-svn: 296968
2017-02-11Update Kaleidoscope tutorial and improve Windows supportMehdi Amini8-169/+237
Many quoted code blocks were not in sync with the actual toy.cpp files. Improve tutorial text slightly in several places. Added some step descriptions crucial to avoid crashes (like InitializeNativeTarget* calls). Solve/workaround problems with Windows (JIT'ed method not found, using custom and standard library functions from host process). Patch by: Moritz Kroll <moritz.kroll@gmx.de> Differential Revision: https://reviews.llvm.org/D29864 llvm-svn: 294870
2017-01-28Use print() instead of dump() in codeMatthias Braun1-2/+4
The dump() functions are meant to be used in a debugger, code should typically use something like print(errs()); llvm-svn: 293365
2016-09-13[Docs] Fix a broken link in the Kaleidoscope tutorial.Davide Italiano1-1/+1
Patch by: Alfred Perlstein <alfred@FreeBSD.org> llvm-svn: 281297
2016-08-28Fix some typos in the docSylvestre Ledru2-2/+2
llvm-svn: 279943
2016-08-08[BuildingAJIT] Fix a couple of typos in the Chapter 3 draft.Lang Hames1-6/+6
llvm-svn: 278033
2016-08-01[ExecutionEngine][MCJIT][Orc] Replace RuntimeDyld::SymbolInfo with JITSymbol.Lang Hames3-32/+32
This patch replaces RuntimeDyld::SymbolInfo with JITSymbol: A symbol class that is capable of lazy materialization (i.e. the symbol definition needn't be emitted until the address is requested). This can be used to support common and weak symbols in the JIT (though this is not implemented in this patch). For consistency, RuntimeDyld::SymbolResolver is renamed to JITSymbolResolver. For space efficiency a new class, JITEvaluatedSymbol, is introduced that behaves like the old RuntimeDyld::SymbolInfo - i.e. it is just a pair of an address and symbol flags. Instances of JITEvaluatedSymbol can be used in symbol-tables to avoid paying the space cost of the materializer. llvm-svn: 277386
2016-07-19[Kaleidoscope][BuildingAJIT] More work on the text for Chapter 3.Lang Hames1-33/+46
Add an overview of stubs and compile callbacks before the discussion of the source changes. -- This line, and those below, will be ignored-- M docs/tutorial/BuildingAJIT3.rst llvm-svn: 275933
2016-07-18Fixed errors in docs.Alexander Kornienko1-0/+3
llvm-svn: 275789
2016-07-15[Kaleidoscope][BuildingAJIT] Start filling in text for chapter 3.Lang Hames1-6/+127
llvm-svn: 275518
2016-07-02fix some various typos in the docSylvestre Ledru3-5/+5
llvm-svn: 274449
2016-07-02New Kaleidoscope chapter: Creating object filesWilfred Hughes12-27/+248
This new chapter describes compiling LLVM IR to object files. The new chaper is chapter 8, so later chapters have been renumbered. Since this brings us to 10 chapters total, I've also needed to rename the other chapters to use two digit numbering. Differential Revision: http://reviews.llvm.org/D18070 llvm-svn: 274441
2016-06-20[Kaleidoscope][BuildingAJIT] Remove some superfluous commas in Chapter 2.Lang Hames1-2/+2
llvm-svn: 273184
2016-06-20[Kaleidoscope][BuildingAJIT] Fix a punctuation mistake in Chapter 2.Lang Hames1-1/+1
llvm-svn: 273183