[docs] Sketch outline for HowToUpdateDebugInfo.rst
authorVedant Kumar <vsk@apple.com>
Sat, 16 May 2020 00:13:18 +0000 (17:13 -0700)
committerVedant Kumar <vsk@apple.com>
Mon, 1 Jun 2020 23:45:18 +0000 (16:45 -0700)
commitb429a0fef047867255e9cb65379677b2af7bb61b
treeb0ea0bc7b7a1d0e5b2189c66bd471e23072fb0e4
parentf573d489b6fccca85e0f2b3765aa17a364a4b0a8
[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
llvm/docs/HowToUpdateDebugInfo.rst [new file with mode: 0644]
llvm/docs/SourceLevelDebugging.rst
llvm/docs/UserGuides.rst