aboutsummaryrefslogtreecommitdiff
path: root/libsframe
diff options
context:
space:
mode:
authorIndu Bhagat <indu.bhagat@oracle.com>2023-05-25 23:44:15 -0700
committerIndu Bhagat <indu.bhagat@oracle.com>2023-05-25 23:44:15 -0700
commit540034ec40b4490705318101300cb425f6c7e667 (patch)
treeb4375de088caf0e60423c225b04b75b5ee1bbc93 /libsframe
parent83c219872b2131546ccec7edc57eb47c64b8911d (diff)
downloadbinutils-540034ec40b4490705318101300cb425f6c7e667.zip
binutils-540034ec40b4490705318101300cb425f6c7e667.tar.gz
binutils-540034ec40b4490705318101300cb425f6c7e667.tar.bz2
sframe/doc: minor improvements for readability
libsframe/ * sframe-spec.texi: Cosmetic fixes.
Diffstat (limited to 'libsframe')
-rw-r--r--libsframe/doc/sframe-spec.texi20
1 files changed, 10 insertions, 10 deletions
diff --git a/libsframe/doc/sframe-spec.texi b/libsframe/doc/sframe-spec.texi
index 6987b6f..5155410 100644
--- a/libsframe/doc/sframe-spec.texi
+++ b/libsframe/doc/sframe-spec.texi
@@ -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