public inbox for binutils-cvs@sourceware.org
 help / color / mirror / Atom feed
From: Indu Bhagat <ibhagat@sourceware.org>
To: bfd-cvs@sourceware.org, gdb-cvs@sourceware.org
Subject: [binutils-gdb] sframe/doc: minor improvements for readability
Date: Fri, 26 May 2023 06:57:59 +0000 (GMT)	[thread overview]
Message-ID: <20230526065759.36FDD385842A@sourceware.org> (raw)

https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=540034ec40b4490705318101300cb425f6c7e667

commit 540034ec40b4490705318101300cb425f6c7e667
Author: Indu Bhagat <indu.bhagat@oracle.com>
Date:   Thu May 25 23:44:15 2023 -0700

    sframe/doc: minor improvements for readability
    
    libsframe/
            * sframe-spec.texi: Cosmetic fixes.

Diff:
---
 libsframe/doc/sframe-spec.texi | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

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

                 reply	other threads:[~2023-05-26  6:57 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230526065759.36FDD385842A@sourceware.org \
    --to=ibhagat@sourceware.org \
    --cc=bfd-cvs@sourceware.org \
    --cc=gdb-cvs@sourceware.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).