diff mbox series

[committed] fix typos in attribute malloc example

Message ID 57b020e2-b3ce-2673-be8d-d596fe734afb@gmail.com
State New
Headers show
Series [committed] fix typos in attribute malloc example | expand

Commit Message

Martin Sebor Feb. 8, 2021, 12:27 a.m. UTC 
I noticed typos in the example of the new form of attribute malloc.
I pushed the attached patch to correct them.

Martin
diff mbox series

Patch

commit fe2034e9c039c998fc5da730ed531c61cf2e0b7d
Author: Martin Sebor <msebor@redhat.com>
Date:   Sun Feb 7 17:21:32 2021 -0700

    Correct typos in attribute malloc documentation.
    
    gcc/ChangeLog:
            * doc/extend.texi (attribute malloc): Correct typos.

diff --git a/gcc/doc/extend.texi b/gcc/doc/extend.texi
index 2cfd8cdf883..e110cb01061 100644
--- a/gcc/doc/extend.texi
+++ b/gcc/doc/extend.texi
@@ -3258,7 +3258,9 @@  objects.
 
 Associating a function with a @var{deallocator} helps detect calls to
 mismatched allocation and deallocation functions and diagnose them under
-the control of options such as @option{-Wmismatched-dealloc}.  To indicate
+the control of options such as @option{-Wmismatched-dealloc}.  It also
+makes it possible to diagnose attempts to deallocate objects that were not
+allocated dynamically, by @option{-Wfree-nonheap-object}.  To indicate
 that an allocation function both satisifies the nonaliasing property and
 has a deallocator associated with it, both the plain form of the attribute
 and the one with the @var{deallocator} argument must be used.  The same
@@ -3273,21 +3275,21 @@  not alias any others, the following declarations make @code{fclose}
 a suitable deallocator for pointers returned from all functions except
 @code{popen}, and @code{pclose} as the only suitable deallocator for
 pointers returned from @code{popen}.  The deallocator functions must
-declared before they can be referenced in the attribute.
+be declared before they can be referenced in the attribute.
 
 @smallexample
 int fclose (FILE*);
 int pclose (FILE*);
 
-__attribute__ ((malloc, malloc (fclose (1))))
-  FILE* fdopen (int);
-__attribute__ ((malloc, malloc (fclose (1))))
+__attribute__ ((malloc, malloc (fclose, 1)))
+  FILE* fdopen (int, const char*);
+__attribute__ ((malloc, malloc (fclose, 1)))
   FILE* fopen (const char*, const char*);
-__attribute__ ((malloc, malloc (fclose (1))))
+__attribute__ ((malloc, malloc (fclose, 1)))
   FILE* fmemopen(void *, size_t, const char *);
-__attribute__ ((malloc, malloc (pclose (1))))
+__attribute__ ((malloc, malloc (pclose, 1)))
   FILE* popen (const char*, const char*);
-__attribute__ ((malloc, malloc (fclose (1))))
+__attribute__ ((malloc, malloc (fclose, 1)))
   FILE* tmpfile (void);
 @end smallexample