mirror/binutils-gdb
2
0
Fork 0
mirror of https://sourceware.org/git/binutils-gdb.git synced 2025-02-17 13:10:12 +08:00
Code Issues Packages Projects Releases Wiki Activity

sframe/doc: minor improvements for readability

Browse Source 
libsframe/
	* sframe-spec.texi: Cosmetic fixes.
This commit is contained in:
Indu Bhagat 2023-05-25 23:44:15 -07:00
parent 83c219872b
commit 540034ec40
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
libsframe/doc/sframe-spec.texi
View File

@ -46,8 +46,8 @@ Frame Pointer (FP).
Return Address (RA).
@end itemize
The reason for existence of the SFrame format is to support fast, online
generation of stack traces using simple means.
The reason for existence of the SFrame format is to provide a simple, fast and
low-overhead mechanism to generate stack traces.
@menu
* Overview::
@ -81,7 +81,7 @@ The associated API to decode, probe and encode the SFrame section, provided via
later.
This document is intended to be in sync with the C code in @file{sframe.h}.
Please report descrepancies between the two, if any.
Please report discrepancies between the two, if any.
@node SFrame section
@chapter SFrame section
@ -234,14 +234,14 @@ of the return address is @code{CFA - 8}. Since this offset is in close
vicinity with the CFA in most ABIs, @code{sfh_cfa_fixed_fp_offset} and
@code{sfh_cfa_fixed_ra_offset} are limited to signed 8-bit integers.
SFrame format has provisioned for future ABIs/architectures that it may
support. The @code{sframe_header} structure provides an unsigned 8-bit
integral field to denote the size of an auxilliary SFrame header. The
auxilliary SFrame header follows right after the @code{sframe_header}
SFrame format has made some provisions for supporting more ABIs/architectures
in the future. The @code{sframe_header} structure provides an unsigned 8-bit
integral field to denote the size of an auxiliary SFrame header. The
auxiliary SFrame header follows right after the @code{sframe_header}
structure. As for the offset calculations, the @emph{end} of SFrame header
must be the end of the auxilliary SFrame header, if the latter is present.
must be the end of the auxiliary SFrame header, if the latter is present.
Tieing it all together:
Putting it all together:
@multitable {Offset} {@code{int8_t sfh_cfa_fixed_fp_offset}} {The number of SFrame FREs in the section.}
@headitem Offset @tab Name @tab Description
@ -263,7 +263,7 @@ Tieing it all together:
@item 0x07
@tab @code{uint8_t sfh_auxhdr_len}
@tab Size in bytes of the auxilliary header that follows the
@tab Size in bytes of the auxiliary header that follows the
@code{sframe_header} structure.
@item 0x08