[COMMITTED] More precise documentation for cleanup attribute [PR110029]

Message ID 20240119021151.2801615-1-sandra@codesourcery.com
State Accepted
Headers
Series [COMMITTED] More precise documentation for cleanup attribute [PR110029] |

Checks

Context Check Description
snail/gcc-patch-check success Github commit url

Commit Message

Sandra Loosemore Jan. 19, 2024, 2:11 a.m. UTC
  gcc/ChangeLog
	PR c/110029
	* doc/extend.texi (Common Variable Attributes): Explain what
	happens when multiple variables with cleanups are in the same scope.
---
 gcc/doc/extend.texi | 5 +++++
 1 file changed, 5 insertions(+)
  

Patch

diff --git a/gcc/doc/extend.texi b/gcc/doc/extend.texi
index 616e26d47dc..0bc586d120e 100644
--- a/gcc/doc/extend.texi
+++ b/gcc/doc/extend.texi
@@ -7782,6 +7782,11 @@  with static storage duration.  The function must take one parameter,
 a pointer to a type compatible with the variable.  The return value
 of the function (if any) is ignored.
 
+When multiple variables in the same scope have @code{cleanup}
+attributes, at exit from the scope their associated cleanup functions
+are run in reverse order of definition (last defined, first
+cleanup).
+
 If @option{-fexceptions} is enabled, then @var{cleanup_function}
 is run during the stack unwinding that happens during the
 processing of the exception.  Note that the @code{cleanup} attribute