[PATCH] D81198: [docs] Specify rules for updating debug locations

[Vedant Kumar via Phabricator via llvm-commits]

vsk created this revision.
vsk added reviewers: jmorse, aprantl, dblaikie.
Herald added a project: LLVM.
vsk added a reviewer: debug-info.

Restructure HowToUpdateDebugInfo.rst to specify rules for when
transformations should preserve, merge, or drop debug locations.

The goal is to have clear, well-justified rules that come with a few
examples and counter-examples, so that pass authors can pick the best
strategy for managing debug locations depending on the specific task at
hand.

I've tried to set down sensible rules here that mostly align with what
we already do in llvm today, and that take a diverse set of use cases
into account (interactive debugging, crash triage, SamplePGO).

Please *do* try to pick these rules apart and suggest clarifications or
improvements :).

Side note: Prior to 24660ea1 <https://reviews.llvm.org/rG24660ea11cb1d4090c68d06ef2a9ba4b9895794f>, this document was structured as a long
list of very specific code transformations -- the idea being that we
would fill in what to do in each specific case. I chose to reorganize
the document as a list of actions to take because it drastically cuts
down on the amount of redundant exposition/explanation needed. I hope
that's fine...


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D81198

Files:
  llvm/docs/HowToUpdateDebugInfo.rst

-------------- next part --------------
A non-text attachment was scrubbed...
Name: D81198.268602.patch
Type: text/x-patch
Size: 5606 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20200604/c7ea8eb6/attachment.bin>