[PATCH 1/2] Expand documentation of common-utils.h::FUNCTION_NAME

[Joel Brobecker <brobecker@adacore.com>]

Hello,

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.

I would commit on its own, but since I am going to put the next in
for the same macro up for review, it's just as easy to make that one
wait as well, in case there are comments.

Thanks,
-- 
Joel

---
 gdb/common/common-utils.h | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/gdb/common/common-utils.h b/gdb/common/common-utils.h
index 2d99549..5960c55 100644
--- 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
-- 
1.8.3.2