[PATCH] D146007: [docs] Document MemProf metadata in LangRef

[Snehasish Kumar via Phabricator via llvm-commits]

snehasish accepted this revision.
snehasish added a comment.
This revision is now accepted and ready to land.

lgtm, thanks for documenting the metadata format.



================
Comment at: llvm/docs/LangRef.rst:7480
+
+Each operand in the ``memprof`` metadata attachment describes the profile
+behavior of memory allocated by the associated allocation for a given context.
----------------
s/profile/profiled ?


================
Comment at: llvm/docs/LangRef.rst:7483
+In the above example, there were 2 profiled contexts, one allocating memory
+that was typically cold and allocating memory that was typically not cold.
+
----------------
"... and one allocating ..."


================
Comment at: llvm/docs/LangRef.rst:7493
+a hash of the callsite's debug info, and the associated call may be in a
+different module. The contexts are listed in order from leafmost call (the
+allocation itself) to the outermost callsite context required for uniquely
----------------
Perhaps hyphenated "leaf-most" is clearer? Another occurrence below if you choose to change it.


================
Comment at: llvm/docs/LangRef.rst:7496
+identifying the described profile behavior (note this may not be the top of
+the call stack).
+
----------------
"the profiled callstack" to make it clearer?


================
Comment at: llvm/docs/LangRef.rst:7508
+:ref:`memprof metadata<md_memprof>`), as well as to other callsites
+in profiled contexts described on heap allocation ``memprof`` metadata.
+
----------------
s/on/in?


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D146007