diff options
| author | Philip Reames <listmail@philipreames.com> | 2018-11-08 17:20:35 +0000 |
|---|---|---|
| committer | Philip Reames <listmail@philipreames.com> | 2018-11-08 17:20:35 +0000 |
| commit | 9ffd5eb0817828c99ffb4c55f36fe736fc072115 (patch) | |
| tree | f42952908ecd7c5ceee7e29d4dcd73928750ece7 /llvm/docs | |
| parent | cf3c9c116f3b17954ae626f5dce9bcbbc4afec5c (diff) | |
| download | bcm5719-llvm-9ffd5eb0817828c99ffb4c55f36fe736fc072115.tar.gz bcm5719-llvm-9ffd5eb0817828c99ffb4c55f36fe736fc072115.zip | |
[docs] Clarify ELF section naming for StackMaps and fix a typo
llvm-svn: 346416
Diffstat (limited to 'llvm/docs')
| -rw-r--r-- | llvm/docs/StackMaps.rst | 7 | ||||
| -rw-r--r-- | llvm/docs/Statepoints.rst | 4 |
2 files changed, 7 insertions, 4 deletions
diff --git a/llvm/docs/StackMaps.rst b/llvm/docs/StackMaps.rst index 99c5e5fbe4d..2ceb408097a 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 d51a862ca72..997e76e7a83 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 <stackmap-format>`. The general expectation is that a JIT compiler will parse and discard this |
