mirrors/llvm-project
0
0
Fork 0
mirror of https://github.com/llvm/llvm-project.git synced 2025-04-19 07:46:49 +00:00
Code Issues Projects Releases Wiki Activity

[docs]: Add a note about using custom types with diagnostics (#73818)

Browse Source
This commit is contained in:
Jeremy Kun 2024-02-08 11:06:43 -08:00 committed by GitHub
parent a56fa161ab
commit 3d71e4166d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
mlir/docs/Diagnostics.md
View File

@ -119,6 +119,14 @@ op->emitError() << anotherOp;
op->emitRemark() << anotherOp;
```
To make a custom type compatible with Diagnostics, one must implement the
following friend function.
```c++
friend mlir::Diagnostic &operator<<(
mlir::Diagnostic &diagnostic, const MyType &foo);
```
### Attaching notes
Unlike many other compiler frameworks, notes in MLIR cannot be emitted directly.