From: Indu Bhagat <indu.bhagat@oracle.com>
Date: Fri, 23 Jan 2026 22:59:11 +0000 (-0800)
Subject: sframe: doc: minor typos and cosmetic fixes
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1a6274360a5c67030e511afc6d4c0a88ad1467a5;p=thirdparty%2Fbinutils-gdb.git

sframe: doc: minor typos and cosmetic fixes

libsframe/
	* doc/sframe-spec.texi: Minor edits.
---

diff --git a/libsframe/doc/sframe-spec.texi b/libsframe/doc/sframe-spec.texi
index f3b346a4089..efd3718e256 100644
--- a/libsframe/doc/sframe-spec.texi
+++ b/libsframe/doc/sframe-spec.texi
@@ -124,8 +124,8 @@ Errata.
 @item
 Terminology improvements and renames for readability
  @itemize @minus
-  @item Use terminology `PC offset' in place of `Addr' for function start PC
-  offset consistently.
+  @item Use the terminology `PC offset' in place of `Addr' for function start
+  PC offset consistently.
   @item Make a distinction between SFrame FDE Type (e.g.,
    @code{SFRAME_FDE_TYPE_DEFAULT}, @code{SFRAME_FDE_TYPE_FLEX}) vs SFrame FDE PC
    Type (i.e., @code{SFRAME_FDE_PCTYPE_MASK}, @code{SFRAME_FDE_PCTYPE_INC}).
@@ -181,7 +181,7 @@ since Version 1 was published.
 @itemize @bullet
 @item
 Add an unsigned 8-bit integral field to the SFrame function descriptor entry to
-encode the size of the repetitive code blocks.  Such code blocks, e.g, pltN
+encode the size of the repetitive code blocks.  Such code blocks, e.g., pltN
 entries, use an SFrame function descriptor entry of type
 @code{SFRAME_FDE_PCTYPE_MASK}.
 @item
@@ -328,7 +328,7 @@ The version of the SFrame format can be determined by inspecting
 @item @code{SFRAME_VERSION_2}
 @tab 2 @tab Second version.
 @item @code{SFRAME_VERSION_3}
-@tab 2 @tab Third version, under development.
+@tab 3 @tab Third version, under development.
 @end multitable
 
 This document describes @code{SFRAME_VERSION_3}.
@@ -372,7 +372,7 @@ undefined flags must be set to zero.
 The SFrame header is the first part of an SFrame section.  It begins with the
 SFrame preamble.  All parts of it other than the preamble
 (@pxref{SFrame Preamble}) can vary between SFrame file versions.  It contains
-things that apply to the section as a whole, and offsets to the various other
+metadata that apply to the section as a whole, and offsets to the various other
 sub-sections defined in the format.  As with the rest of the SFrame section,
 all values are stored in the endianness of the target system.
 
@@ -500,7 +500,7 @@ Putting it all together:
 
 SFrame header identifies the ABI/arch of the target system for which the
 executable and hence, the stack trace information contained in the SFrame
-section, is intended.  There are currently three identifiable ABI/arch values
+section, is intended.  There are currently four identifiable ABI/arch values
 in the format.
 
 @multitable {SFRAME_ABI_AARCH64_ENDIAN_LITTLE} {Value} {@code{AArch64 little-endian}}
@@ -565,8 +565,8 @@ typedef struct sframe_func_desc_idx
 @} ATTRIBUTE_PACKED sframe_func_desc_idx;
 @end example
 
-Each entry of the SFrame function descriptor index is naturally aligned.
-Following table describes each component of the SFrame FDE index entry:
+Each entry of the SFrame function descriptor index is naturally aligned.  The
+following table describes each component of the SFrame FDE index entry:
 
 @multitable {Offset} {@code{uint32_t}} {@code{sfdi_func_start_fre_off}} {Signed 32-bit integral field denoting the}
 @headitem Offset @tab Type @tab Name @tab Description
@@ -665,7 +665,7 @@ bytes.  These bytes contain vital information necessary to:
 @itemize @minus
  @item read and interpret SFrame FRE data, e.g., the number and size of each
 SFrame FRE offset,
- @item PC type for SFrame FDE,
+ @item PC Type for SFrame FDE,
  @item type of SFrame FDE,
  @item size of repeat block, if PC Type is @code{SFRAME_FDE_PCTYPE_MASK}.
 @end itemize
@@ -694,7 +694,7 @@ Unsed in AMD64, s390x
 
 @item 4
 @tab @code{fde_pctype}
-@tab Specify the SFrame FDE PC type.  Two possible values: @*
+@tab Specify the SFrame FDE PC Type.  Two possible values: @*
 @code{SFRAME_FDE_PCTYPE_MASK} (1), or @*
 @code{SFRAME_FDE_PCTYPE_INC} (0). @*
 @xref{The SFrame FDE PC Types}.
@@ -748,7 +748,7 @@ stub is used repeteadly for a specific functionality, like PLT entries and
 trampolines.
 
 @multitable {@code{SFRAME_V3_FDE_PCTYPE_MASK}} {Value} {Unwinders perform a Unwinders perform a fo}
-@headitem Name of SFrame FDE PC type @tab Value @tab Description
+@headitem Name of SFrame FDE PC Type @tab Value @tab Description
 
 @item @code{SFRAME_V3_FDE_PCTYPE_INC}
 @tab 0 @tab Stacktracers perform a @*