diff mbox series

[COMMITTED] sframe/doc: minor improvements for readability

Message ID 20230526070132.4185600-4-indu.bhagat@oracle.com
State Accepted
Headers
Series [COMMITTED] sframe/doc: minor improvements for readability |

Checks

Context Check Description
snail/binutils-gdb-check success Github commit url

Commit Message

Indu Bhagat May 26, 2023, 7:01 a.m. UTC 
  libsframe/
	* sframe-spec.texi: Cosmetic fixes.
---
 libsframe/doc/sframe-spec.texi | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)
diff mbox series

Patch

diff --git a/libsframe/doc/sframe-spec.texi b/libsframe/doc/sframe-spec.texi
index 6987b6fee13..5155410bdc8 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