Expand documentation of common-utils.h::FUNCTION_NAME

While looking at this macro, I noticed that it wasn't always necessarily
defined. That prompted me to search the current sources to make sure
that all uses were adequately protected, which they were. But to help
prevent future uses to be made unprotected, this patch expands the
current macro documentation a bit.

gdb/ChangeLog:

        * common/common-utils.h (FUNCTION_NAME): Expand the macro's
        documentation a bit.

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index 66f040b7f8389aa455f5964a78906498d2459b40..2ccf1cb8debc17bf63be6807c532339bb6a50b92 100644 (file)
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,3 +1,8 @@
+2014-01-22  Joel Brobecker  <brobecker@adacore.com>
+
+       * common/common-utils.h (FUNCTION_NAME): Expand the macro's
+       documentation a bit.
+
 2014-01-21  Roland McGrath  <mcgrathr@google.com>
 
        * configure.ac: Call AM_PROG_INSTALL_STRIP.

diff --git a/gdb/common/common-utils.h b/gdb/common/common-utils.h
index 2d995490b9171cde4ad2ee4c5d1f962ca78197bc..5960c5521653f63682d66320f0baba46831b5cff 100644 (file)
--- a/gdb/common/common-utils.h
+++ b/gdb/common/common-utils.h
@@ -25,7 +25,12 @@
 #include <stddef.h>
 #include <stdarg.h>
 
-/* Version 2.4 and later of GCC define a magical variable `__PRETTY_FUNCTION__'
+/* If possible, define FUNCTION_NAME, a macro containing the name of
+   the function being defined.  Since this macro may not always be
+   defined, all uses must be protected by appropriate macro definition
+   checks (Eg: "#ifdef FUNCTION_NAME").
+
+   Version 2.4 and later of GCC define a magical variable `__PRETTY_FUNCTION__'
    which contains the name of the function currently being defined.
    This is broken in G++ before version 2.6.
    C9x has a similar variable called __func__, but prefer the GCC one since