doc: sframe: Clarify FDE/FRE function/range start address fields

The function start address in a SFrame FDE (sfde_func_start_address)
is encoded as a signed offset to the function start address from the
SFrame section.

The PC range start address in a SFrame FRE (sfre_start_address) is
encoded as an unsigned offset to the range from the function start
address.

Signed-off-by: Jens Remus <jremus@linux.ibm.com>

diff --git a/libsframe/doc/sframe-spec.texi b/libsframe/doc/sframe-spec.texi
index eb706901d7fdbec2d09359f65d45a5b7e2c00c19..ae115705ca73eb65377f845aaa53783563646333 100644 (file)
--- a/libsframe/doc/sframe-spec.texi
+++ b/libsframe/doc/sframe-spec.texi
@@ -459,7 +459,9 @@ Following table describes each component of the SFrame FDE structure:
 @tab @code{int32_t}
 @tab @code{sfde_func_start_address}
 @tab Signed 32-bit integral field denoting the virtual memory address of the
-described function.
+described function, for which the SFrame FDE applies.  The value encoded in
+the @code{sfde_func_start_address} field is the offset in bytes of the
+function's start address, from the SFrame section.
 
 @item 0x04
 @tab @code{uint32_t}
@@ -684,10 +686,10 @@ serializing and deserializing entities, if unaligned accesses need to be
 avoided.
 
 @code{sfre_start_address} is an unsigned 8-bit/16-bit/32-bit integral field
-identifies the start address of the range of program counters, for which the
+denoting the start address of a range of program counters, for which the
 SFrame FRE applies.  The value encoded in the @code{sfre_start_address} field
-is the offset in bytes of the start address of the SFrame FRE, from the start
-address of the function.
+is the offset in bytes of the range's start address, from the start address
+of the function.
 
 Further SFrame FRE types may be added in future.