[all-commits] [llvm/llvm-project] b429a0: [docs] Sketch outline for HowToUpdateDebugInfo.rst

[Vedant Kumar via All-commits]

  Branch: refs/heads/master
  Home:   https://github.com/llvm/llvm-project
  Commit: b429a0fef047867255e9cb65379677b2af7bb61b
      https://github.com/llvm/llvm-project/commit/b429a0fef047867255e9cb65379677b2af7bb61b
  Author: Vedant Kumar <vsk at apple.com>
  Date:   2020-06-01 (Mon, 01 Jun 2020)

  Changed paths:
    A llvm/docs/HowToUpdateDebugInfo.rst
    M llvm/docs/SourceLevelDebugging.rst
    M llvm/docs/UserGuides.rst

  Log Message:
  -----------
  [docs] Sketch outline for HowToUpdateDebugInfo.rst

Summary:
Sketch the outline for a new document that explains how to update debug
info in various kinds of code transformations.

Some of the guidelines that belong in HowToUpdateDebugInfo.rst were in
SourceLevelDebugging.rst already under the debugify section. It seems
like the distinction between the two docs ought to be that the former is
more prescriptive, while the latter is more descriptive.

To that end I've consolidated the "how to update debug info" guidelines
which were in SourceLevelDebugging.rst into the new doc, along with the
information about using "debugify" to test transformations. Since we've
added a mir-debugify pass, I've described that as well.

Reviewers: aprantl, jmorse, chrisjackson, dsanders

Subscribers: llvm-commits

Tags: #llvm

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