diff mbox series

[committed] libstdc++: Adjust uses of null pointer constants in docs

Message ID 20230418231500.585632-1-jwakely@redhat.com
State Repeat Merge
Headers
Series [committed] libstdc++: Adjust uses of null pointer constants in docs |

Checks

Context Check Description
snail/gcc-patch-check warning Git am fail log

Commit Message

Jonathan Wakely April 18, 2023, 11:15 p.m. UTC 
  Tested x86_64-linux. Pushed to trunk.

-- >8 --

libstdc++-v3/ChangeLog:

	* doc/xml/manual/extensions.xml: Fix example to declare and
	qualify std::free, and use NULL instead of 0.
	* doc/html/manual/ext_demangling.html: Regenerate.
	* libsupc++/cxxabi.h: Adjust doxygen comments.
---
 libstdc++-v3/doc/html/manual/ext_demangling.html | 8 +++-----
 libstdc++-v3/doc/xml/manual/extensions.xml       | 8 +++-----
 libstdc++-v3/libsupc++/cxxabi.h                  | 4 ++--
 3 files changed, 8 insertions(+), 12 deletions(-)
diff mbox series

Patch

diff --git a/libstdc++-v3/doc/html/manual/ext_demangling.html b/libstdc++-v3/doc/html/manual/ext_demangling.html
index 028ec71d8c8..1e7cdda8326 100644
--- a/libstdc++-v3/doc/html/manual/ext_demangling.html
+++ b/libstdc++-v3/doc/html/manual/ext_demangling.html
@@ -26,6 +26,7 @@ 
   </p><pre class="programlisting">
 #include &lt;exception&gt;
 #include &lt;iostream&gt;
+#include &lt;cstdlib&gt;
 #include &lt;cxxabi.h&gt;
 
 struct empty { };
@@ -33,7 +34,6 @@  struct empty { };
 template &lt;typename T, int N&gt;
   struct bar { };
 
-
 int main()
 {
   int     status;
@@ -43,11 +43,9 @@  int main()
   bar&lt;empty,17&gt;          u;
   const std::type_info  &amp;ti = typeid(u);
 
-  realname = abi::__cxa_demangle(ti.name(), 0, 0, &amp;status);
+  realname = abi::__cxa_demangle(ti.name(), NULL, NULL, &amp;status);
   std::cout &lt;&lt; ti.name() &lt;&lt; "\t=&gt; " &lt;&lt; realname &lt;&lt; "\t: " &lt;&lt; status &lt;&lt; '\n';
-  free(realname);
-
-  return 0;
+  std::free(realname);
 }
    </pre><p>
      This prints
diff --git a/libstdc++-v3/doc/xml/manual/extensions.xml b/libstdc++-v3/doc/xml/manual/extensions.xml
index 196b55d8347..daa98f5cba7 100644
--- a/libstdc++-v3/doc/xml/manual/extensions.xml
+++ b/libstdc++-v3/doc/xml/manual/extensions.xml
@@ -521,6 +521,7 @@  get_temporary_buffer(5, (int*)0);
    <programlisting>
 #include &lt;exception&gt;
 #include &lt;iostream&gt;
+#include &lt;cstdlib&gt;
 #include &lt;cxxabi.h&gt;
 
 struct empty { };
@@ -528,7 +529,6 @@  struct empty { };
 template &lt;typename T, int N&gt;
   struct bar { };
 
-
 int main()
 {
   int     status;
@@ -538,11 +538,9 @@  int main()
   bar&lt;empty,17&gt;          u;
   const std::type_info  &amp;ti = typeid(u);
 
-  realname = abi::__cxa_demangle(ti.name(), 0, 0, &amp;status);
+  realname = abi::__cxa_demangle(ti.name(), NULL, NULL, &amp;status);
   std::cout &lt;&lt; ti.name() &lt;&lt; "\t=&gt; " &lt;&lt; realname &lt;&lt; "\t: " &lt;&lt; status &lt;&lt; '\n';
-  free(realname);
-
-  return 0;
+  std::free(realname);
 }
    </programlisting>
    <para>
diff --git a/libstdc++-v3/libsupc++/cxxabi.h b/libstdc++-v3/libsupc++/cxxabi.h
index 10179bc0a0d..ac0637b0343 100644
--- a/libstdc++-v3/libsupc++/cxxabi.h
+++ b/libstdc++-v3/libsupc++/cxxabi.h
@@ -169,7 +169,7 @@  namespace __cxxabiv1
    *  @param __output_buffer A region of memory, allocated with
    *  malloc, of @a *__length bytes, into which the demangled name is
    *  stored.  If @a __output_buffer is not long enough, it is
-   *  expanded using realloc.  @a __output_buffer may instead be NULL;
+   *  expanded using realloc.  @a __output_buffer may instead be null;
    *  in that case, the demangled name is placed in a region of memory
    *  allocated with malloc.
    *
@@ -184,7 +184,7 @@  namespace __cxxabiv1
    *  -3: One of the arguments is invalid.
    *
    *  @return A pointer to the start of the NUL-terminated demangled
-   *  name, or NULL if the demangling fails.  The caller is
+   *  name, or a null pointer if the demangling fails.  The caller is
    *  responsible for deallocating this memory using @c free.
    *
    *  The demangling is performed using the C++ ABI mangling rules,