mlir/docs/Diagnostics.md

13 Source location information is extremely important for any compiler, because it
14 provides a baseline for debuggability and error-reporting. The
15 [builtin dialect](Dialects/Builtin.md) provides several different location
70 // These methods use the location attached to the operation.
103 op->emitError() << "Compose an interesting error: " << fooAttr << ", " << fooType
107 "Compose an interesting error: @foo, i32, (0, 1, 2)"
113 They must be explicitly attached to another diagnostic non-note diagnostic. When
115 attaching a note, if the user does not provide an explicit source location the
116 note will inherit the location of the parent diagnostic.
119 // Emit a note with an explicit source location.
122 // Emit a note that inherits the parent location.
152 the textual form of that operation is printed and attached as a note to the
158 test.mlir:3:3: error: 'module_terminator' op expects parent op 'builtin.module'
161 test.mlir:3:3: note: see current operation: "module_terminator"() : () -> ()
170 When a diagnostic is emitted, attach the current stack trace as a note to the
175 test.mlir:3:3: error: 'module_terminator' op expects parent op 'builtin.module'
178 test.mlir:3:3: note: diagnostic emitted with trace:
233 /tmp/test.mlir:6:24: error: expected non-function type
248 In some situations, a diagnostic may be emitted with a callsite location in a
261 // user. This functor should return true when a location should be shown, and
262 // false otherwise. When filtering a container location, such as a NameLoc, this
263 // function should not recurse into the child location. Recursion into nested
264 // location is performed as necessary by the caller.
282 Note: In the case where all locations are filtered out, the first location in
291 *   `expected-(error|note|remark|warning) {{ message }}`
296 // Expect an error on the same line.
298   br ^missing  // expected-error {{reference to an undefined block}}
301 // Expect an error on an adjacent line.
303   // expected-error@+1 {{unknown comparison predicate "foo"}}
308 // Expect an error on the next line that does not contain a designator.
313 // Expect an error on the previous line that does not contain a designator.
320 The handler will report an error if any unexpected diagnostics were seen, or if
326 /tmp/test.mlir:6:24: error: unexpected error: expected non-function type
330 /tmp/test.mlir:15:4: error: expected remark "expected some remark" was not produced