Document pragmatics of why gdb_assert() is lowercase.

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index d498458cc072341405051813fc958c83fca11702..d3d62bef7dcfa241f7e72c0ff3d067c1a9299c7d 100644 (file)
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,3 +1,7 @@
+2001-03-01  Andrew Cagney  <ac131313@redhat.com>
+
+       * gdb_assert.h: Document pragmatics behind gdb_assert's case.
+
 2001-03-01  Andrew Cagney  <ac131313@redhat.com>
 
        * Makefile.in (gdbtk-cmds.o): Add $(regcache_h) to dependency

diff --git a/gdb/gdb_assert.h b/gdb/gdb_assert.h
index c9979dbddf52b6c68e0e051fea1bb4f7988af20f..4f0bcdc94978550e983454b34a048e41777cb6e1 100644 (file)
--- a/gdb/gdb_assert.h
+++ b/gdb/gdb_assert.h
@@ -21,6 +21,11 @@
 #ifndef GDB_ASSERT_H
 #define GDB_ASSERT_H
 
+/* PRAGMATICS: "gdb_assert.h":gdb_assert() is a lower case (rather
+   than upper case) macro since that provides the closest fit to the
+   existing lower case macro <assert.h>:assert() that it is
+   replacing. */
+
 #define gdb_assert(expr)                                                      \
   ((void) ((expr) ? 0 :                                                       \
           (gdb_assert_fail (#expr, __FILE__, __LINE__, ASSERT_FUNCTION), 0)))