[PATCH] Documentation for llvm.experimental.stackmap and llvm.experimental.patchpoint.

Sean Silva silvas at purdue.edu
Tue Oct 22 13:07:37 PDT 2013


  These docs LGTM with a couple nits.

  Also, could you reflow the paragraphs to 80 columns? (some of them are, others aren't 80-col).


================
Comment at: docs/Stackmaps.rst:200-201
@@ +199,4 @@
+
+The stackmap format is a contract between a specific revision of LLVM
+and the runtime. Consequently, its design is motivated by simplicity
+and extensibility. Compactness of the representation is secondary
----------------
SVN revision? or (minor) version? I think it is very important to be crystal clear about the exact compatibility that is intended. Maybe waive the issue by saying that the "experimental status" of these intrinsics means that the format is subject to change currently (it may nonetheless be desirable to state what the "expected" eventual format compatibility guarantee will be, so that prospective users can tell if this will fit their use case)

================
Comment at: docs/Stackmaps.rst:213
@@ +212,3 @@
+
+Stackmaps differ from debug information in their IR semantics and division of responsibility between LLVM and its client. For stackmaps, LLVM precisely represents a set of values at a specific point in the IR. The information is limited only to that point as opposed to arbitrary instructions, but at that point it must be complete and accurate. At the instruction address assoicated with a stackmap, the stack frame may be discarded and execution resumed with only the information provided by the stackmap.
+
----------------
typo: assoicated -> associated


http://llvm-reviews.chandlerc.com/D1981



More information about the llvm-commits mailing list