[all-commits] [llvm/llvm-project] 7a1d5e: [DebugInfo][NFC] Add instr-ref documentation, migr...

[J. Ryan Stinnett via All-commits]

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: 7a1d5ef703f676f03e2f623c7d209ded9a5f94e4
      https://github.com/llvm/llvm-project/commit/7a1d5ef703f676f03e2f623c7d209ded9a5f94e4
  Author: J. Ryan Stinnett <jryans at gmail.com>
  Date:   2022-05-20 (Fri, 20 May 2022)

  Changed paths:
    A llvm/docs/InstrRefDebugInfo.md
    M llvm/docs/MIRLangRef.rst
    M llvm/docs/UserGuides.rst

  Log Message:
  -----------
  [DebugInfo][NFC] Add instr-ref documentation, migration guide

This used to be D102158, but all the code it describes got re-written, so I
figured I'd take another shot at documenting the new instruction referencing
variable locations, this time from a higher level. Happily there's no longer any
need to describe LiveDebugValues in any detail seeing how it's all SSA-based
now.

Probably the most important part is the explanation of what targets need to do
to support instruction referencing. The list is small, mostly because there's
nothing especially complicated that targets need to do: just instrument their
target-specific optimisations and implement the stack spill/restore recognition
target hooks.

This is a small amount of text (which is a virtue), I'm extremely happy to
expand on anything.

Differential Revision: https://reviews.llvm.org/D113586

Co-authored-by: Jeremy Morse <jeremy.morse at sony.com>