From: Indu Bhagat <indu.bhagat@oracle.com>
Date: Tue, 27 May 2025 05:26:29 +0000 (-0700)
Subject: doc: sframe: update documentation for sfde_func_start_address
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f2d459669ae1d523eedd0440e008eedcba240cc8;p=thirdparty%2Fbinutils-gdb.git

doc: sframe: update documentation for sfde_func_start_address

libsframe/doc/
	* sframe-spec.texi: Add details about sfde_func_start_address
	encoding.
---

diff --git a/libsframe/doc/sframe-spec.texi b/libsframe/doc/sframe-spec.texi
index 1725672c038..e4cfe01204c 100644
--- a/libsframe/doc/sframe-spec.texi
+++ b/libsframe/doc/sframe-spec.texi
@@ -478,9 +478,11 @@ 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, 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.
+described function, for which the SFrame FDE applies.  If the flag
+@code{SFRAME_F_FDE_FUNC_START_ADDR_PCREL}, @xref{SFrame Flags}, in the SFrame
+header is set, the value encoded in the @code{sfde_func_start_address} field is
+the offset in bytes to the function's start address, from the SFrame
+@code{sfde_func_start_address} field.
 
 @item 0x04
 @tab @code{uint32_t}