[PATCH] D80052: [docs] Sketch outline for HowToUpdateDebugInfo.rst

[Daniel Sanders via Phabricator via llvm-commits]

dsanders added a comment.

Thanks for working on this. I had a couple inline comments.

We should probably mention the LostDebugLocObserver that can be integrated into passes to detect location loss while a pass runs.



================
Comment at: llvm/docs/HowToUpdateDebugInfo.rst:264-266
+The ``debugify`` utility described in
+:ref:`Mutation testing for IR-level transformations` can be used for MIR-level
+transformations as well.
----------------
This is slightly misleading because the MIR one is called `mir-debugify` and we don't have a check pass, we just strip it


================
Comment at: llvm/docs/HowToUpdateDebugInfo.rst:277-282
+To run MIRDebugify, simply add ``mir-debugify`` to your ``llc`` invocation,
+like:
+
+.. code-block:: bash
+
+  $ llc -run-pass=mir-debugify ...
----------------
This will only run `mir-debugify` and not the normal pipeline. If you want to run it with a specific pass you need `-run-pass=mir-debugify,other-pass`.

To run it as part of the normal pipeline there's `-debugify-and-strip-all-safe` which can be combined with `-start-before`/`-start-after`. There's currently no way to run it once and then resume the normal pipeline without running it between every pass.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D80052/new/

https://reviews.llvm.org/D80052