From: Philip Reames Date: Thu, 8 Nov 2018 17:20:35 +0000 (+0000) Subject: [docs] Clarify ELF section naming for StackMaps and fix a typo X-Git-Tag: llvmorg-8.0.0-rc1~4721 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=9ffd5eb0817828c99ffb4c55f36fe736fc072115;p=platform%2Fupstream%2Fllvm.git [docs] Clarify ELF section naming for StackMaps and fix a typo llvm-svn: 346416 --- diff --git a/llvm/docs/StackMaps.rst b/llvm/docs/StackMaps.rst index 99c5e5fbe4de..2ceb408097a7 100644 --- a/llvm/docs/StackMaps.rst +++ b/llvm/docs/StackMaps.rst @@ -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 =============== diff --git a/llvm/docs/Statepoints.rst b/llvm/docs/Statepoints.rst index d51a862ca72d..997e76e7a832 100644 --- a/llvm/docs/Statepoints.rst +++ b/llvm/docs/Statepoints.rst @@ -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 `. The general expectation is that a JIT compiler will parse and discard this