[docs] Clarify ELF section naming for StackMaps and fix a typo
authorPhilip Reames <listmail@philipreames.com>
Thu, 8 Nov 2018 17:20:35 +0000 (17:20 +0000)
committerPhilip Reames <listmail@philipreames.com>
Thu, 8 Nov 2018 17:20:35 +0000 (17:20 +0000)
llvm-svn: 346416

llvm/docs/StackMaps.rst
llvm/docs/Statepoints.rst

index 99c5e5f..2ceb408 100644 (file)
@@ -427,8 +427,11 @@ this section, it invokes the callback and passes the section name. The
 JIT can record the in-memory address of the section at this time and
 later parse it to recover the stack map data.
 
-On Darwin, the stack map section name is "__llvm_stackmaps". The
-segment name is "__LLVM_STACKMAPS".
+For MachO (e.g. on Darwin), the stack map section name is
+"__llvm_stackmaps". The segment name is "__LLVM_STACKMAPS".
+
+For ELF (e.g. on Linux), the stack map section name is
+".llvm_stackmaps".  The segment name is "__LLVM_STACKMAPS".
 
 Stack Map Usage
 ===============
index d51a862..997e76e 100644 (file)
@@ -591,8 +591,8 @@ Stack Map Format
 
 Locations for each pointer value which may need read and/or updated by
 the runtime or collector are provided in a separate section of the
-generated object file as specified specified in the PatchPoint
-documentation.  This special section is encoded per the
+generated object file as specified in the PatchPoint documentation.
+This special section is encoded per the
 :ref:`Stack Map format <stackmap-format>`.
 
 The general expectation is that a JIT compiler will parse and discard this