[all-commits] [llvm/llvm-project] d8a521: [mlir][doc] Slightly clarify bufferization documen...

[Rik Huijzer via All-commits]

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

  Changed paths:
    M mlir/docs/Bufferization.md

  Log Message:
  -----------
  [mlir][doc] Slightly clarify bufferization documentation (#70212)

I was reading through the very well written Destination-Passing Style
docs. Even though I know not much about compilers, I managed to
understand it pretty well. A few things tripped me up though, which this
PR suggests to rewrite:

1. Write `buffer(%0)` instead of buffer(`%0`). While reading, I first
interpreted the text as "the buffer (%0)", whereas it should be
interpreted as pseudocode for "a function that determines the buffer
applied to %0". Quickly introducing it and moving the backticks around
as this PR does should make this more clear. Also, I verified that MLIR
does not contain any other occurences of `"buffer(<BACKTICK>"`. It does
contain many occurences of `"buffer("` (without the backtick after the
opening bracket), so this PR makes notation a bit more consistent.
2. Quotation marks slowed me down during reading, so I removed them. I
think it's also clear without.
3. The `outs` from `linalg` was suddenly introduced. I've tried to
clarify in as few words as possible that `outs` stands for `outputs` but
suggestions are welcome.