[PATCH] D63083: [DebugInfo][Docs] Document that prologue/epilogue variable location changes are ignored

Tue Jun 11 04:35:24 PDT 2019

jmorse marked 2 inline comments as done.
jmorse added a comment.

In D63083#1536776 <https://reviews.llvm.org/D63083#1536776>, @rnk wrote:

> I should add, it's really just the commit message that I find confusing. I think the documentation as written clearly documents LLVM's existing behavior.

Curses -- I've been treating the phab summary more as a "message to reviewers" rather than a commit message (I should have clocked this would cause confusion). I've edited in an actual commit message, up to the tilde character.

In D63083#1536602 <https://reviews.llvm.org/D63083#1536602>, @echristo wrote:

> I'm tagging in Roland here since he and I were just discussing this the other day. I'm not entirely sure what we want to document here as I'm torn on whether or not we should be doing more here.

Cool -- by "more", you mean describe more variable locations in prologues / epilogues? This isn't an area of deep experience for me, I'd be interested in the reasoning for extending that information (is the explanation this patch adds to the documentation wrong/incomplete?)

================
Comment at: docs/SourceLevelDebugging.rst:586
+ * The first operand can record the variable location as a register,
+   a frame index, an
    immediate, or the base address register if the original debug intrinsic
----------------
bjope wrote:
> I guess the formatting was choosen to avoid unnecessary diffs.
> I usually end up reading the .rst files as plain text more often than I read the docs using some browser etc. which makes this look weird.
> nit: Not sure what the common practice is, but I don't mind if line breaks are updated for the full sentence/paragraph.
Indeed @ the formatting, I've updated the diff to normalise the formatting, keeping this uncommitted for the moment due to the extra interest.

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

https://reviews.llvm.org/D63083