[all-commits] [llvm/llvm-project] 9a8ff3: [mlir][doc] Trim summary text during DocGen (#68477)

Rik Huijzer via All-commits all-commits at lists.llvm.org
Fri Oct 13 01:09:58 PDT 2023


  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: 9a8ff346bb20a684e8edd62035077aba06bea084
      https://github.com/llvm/llvm-project/commit/9a8ff346bb20a684e8edd62035077aba06bea084
  Author: Rik Huijzer <github at huijzer.xyz>
  Date:   2023-10-13 (Fri, 13 Oct 2023)

  Changed paths:
    M mlir/tools/mlir-tblgen/OpDocGen.cpp

  Log Message:
  -----------
  [mlir][doc] Trim summary text during DocGen (#68477)

When defining a multi-line string in tblgen, the output in the Markdown
file currently contains too much whitespace and newlines for Hugo's
Markdown parser. For example, for `arith.addui_extended` the tblgen
```tblgen
let summary = [{
  extended unsigned integer addition operation returning sum and overflow bit
}];
```
is currently converted to
```markdown
_
    extended unsigned integer addition operation returning sum and overflow bit
  _
```
which causes the text to not be italicized (as can be seen at
https://mlir.llvm.org/docs/Dialects/ArithOps/#arithaddui_extended-arithadduiextendedop).
After this PR, the output becomes
```
_Extended unsigned integer addition operation returning sum and overflow bit_
```




More information about the All-commits mailing list