[PATCH] D85955: Fix errors in the documentation for StkMapRecord

[Amir Khordadi via Phabricator via llvm-commits]

khordadi created this revision.
khordadi added reviewers: ributzka, atrick.
Herald added subscribers: dexonsmith, hiraditya.
Herald added a project: LLVM.
khordadi requested review of this revision.

The patch is straightforward and the reasons for the changes are obvious.

1. In `llvm/lib/CodeGen/StackMaps.cpp`, the comments above `StackMaps::emitCallsiteEntries` doesn't reflect the actual implementation of the `StackMaps::emitCallsiteEntries`.
2. In `llvm/docs/StackMaps.rst`, a `{` is missing.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D85955

Files:
  llvm/docs/StackMaps.rst
  llvm/lib/CodeGen/StackMaps.cpp


Index: llvm/lib/CodeGen/StackMaps.cpp
===================================================================
--- llvm/lib/CodeGen/StackMaps.cpp
+++ llvm/lib/CodeGen/StackMaps.cpp
@@ -469,10 +469,13 @@
 ///   uint16 : NumLocations
 ///   Location[NumLocations] {
 ///     uint8  : Register | Direct | Indirect | Constant | ConstantIndex
-///     uint8  : Size in Bytes
+///     uint8  : Reserved (expected to be 0)
+///     uint16 : Location Size
 ///     uint16 : Dwarf RegNum
-///     int32  : Offset
+///     uint16 : Reserved (expected to be 0)
+///     int32  : Offset or SmallConstant
 ///   }
+///   uint32 : Padding (only if required to align to 8 byte)
 ///   uint16 : Padding
 ///   uint16 : NumLiveOuts
 ///   LiveOuts[NumLiveOuts] {
Index: llvm/docs/StackMaps.rst
===================================================================
--- llvm/docs/StackMaps.rst
+++ llvm/docs/StackMaps.rst
@@ -350,7 +350,7 @@
     uint32 : Padding (only if required to align to 8 byte)
     uint16 : Padding
     uint16 : NumLiveOuts
-    LiveOuts[NumLiveOuts]
+    LiveOuts[NumLiveOuts] {
       uint16 : Dwarf RegNum
       uint8  : Reserved
       uint8  : Size in Bytes


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D85955.285557.patch
Type: text/x-patch
Size: 1164 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20200814/98acdb5d/attachment.bin>