extend.texi: Update __builtin_return_address and __builtin_frame_address.

2001-07-23  H.J. Lu  (hjl@gnu.org)

	* doc/extend.texi: Update __builtin_return_address and
	__builtin_frame_address.

From-SVN: r44281

diff --git a/gcc/ChangeLog b/gcc/ChangeLog
index e2437a2c809b71b7b4db3988395b8f4ab02bc32c..c7c0c760dc69aa26a313c8e9121cf27469819eec 100644 (file)
--- a/gcc/ChangeLog
+++ b/gcc/ChangeLog
@@ -1,3 +1,8 @@
+2001-07-23  H.J. Lu  (hjl@gnu.org)
+
+       * doc/extend.texi: Update __builtin_return_address and
+       __builtin_frame_address.
+
 2001-07-23  Richard Henderson  <rth@redhat.com>
 
        * config/i386/i386.c (ix86_expand_setcc): Don't use method 0

diff --git a/gcc/doc/extend.texi b/gcc/doc/extend.texi
index 74dd33effd72b64f85881beeef37c05c80b7f5ec..787b722aa0e708b2295afec590e6a0a2be2f9269 100644 (file)
--- a/gcc/doc/extend.texi
+++ b/gcc/doc/extend.texi
@@ -3703,7 +3703,9 @@ The @var{level} argument must be a constant integer.
 
 On some machines it may be impossible to determine the return address of
 any function other than the current one; in such cases, or when the top
-of the stack has been reached, this function will return @code{0}.
+of the stack has been reached, this function will return @code{0} or a
+random value. In addition, @code{__builtin_frame_address} may be used
+to determine if the top of the stack has been reached.
 
 This function should only be used with a non-zero argument for debugging
 purposes.
@@ -3725,8 +3727,13 @@ has a dedicated frame pointer register, and the function has a frame,
 then @code{__builtin_frame_address} will return the value of the frame
 pointer register.
 
-The caveats that apply to @code{__builtin_return_address} apply to this
-function as well.
+On some machines it may be impossible to determine the frame address of
+any function other than the current one; in such cases, or when the top
+of the stack has been reached, this function will return @code{0} if
+the first frame pointer is properly initialized by the startup code.
+
+This function should only be used with a non-zero argument for debugging
+purposes.
 @end deftypefn
 
 @node Other Builtins