[docs] Add basic pass tutorial #7012
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
teqdruid
approved these changes
May 9, 2024
There was a problem hiding this comment.
Nice! Thanks for doing this. You can separate out the LLD bits and just push them to main.
You should also point out that a more complete tutorial about all aspects of MLIR design (CIRCT just being a set of MLIR dialects and passes) is available in the MLIR repo/documentation. In general, we need to plaster these types of comments all over the documentation.
There's nothing worse than an outdated tutorial, so as a future improvement we should separate out the pass, put the tutorial code in its own directory, and write tests for it.
youngar
reviewed
May 9, 2024
youngar
reviewed
May 9, 2024
youngar
reviewed
May 9, 2024
uenoku
reviewed
May 9, 2024
uenoku
reviewed
May 9, 2024
seldridge
reviewed
May 9, 2024
seldridge
reviewed
May 9, 2024
seldridge
reviewed
May 9, 2024
|
#7018 Let me know if you all agree with the flags I added. |
dobios
changed the title
|
Better? |
uenoku
reviewed
May 10, 2024
docs/GettingStarted.md
Outdated
| @@ -67,7 +67,7 @@ $ mkdir llvm/build | |||
| $ cd llvm/build | |||
| $ cmake -G Ninja ../llvm \ | |||
| -DLLVM_ENABLE_PROJECTS="mlir" \ | |||
| -DLLVM_TARGETS_TO_BUILD="X86;RISCV" \ | |||
| -DLLVM_TARGETS_TO_BUILD="s/X86;RISCV/host/" \ | |||
There was a problem hiding this comment.
yeah substitution error on my end, should be just host
uenoku
approved these changes
May 10, 2024
…nto dev/dobios/docs-improvement
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Getting Started contains a decent amount of info but lacks a good tutorial for people who want to quickly learn how to hack together a working CIRCT pass. This PR adds a really basic tutorial that hopefully does just that.
I also added the
-DLLVM_ENABLE_LLD=trueflag to the cmake tutorial, because everyone should be using lld, it reduces the memory usage during linking by orders of magnitude.Let me know what you all think!