From: Andrew Cagney <cagney@redhat.com>
Date: Thu, 1 Mar 2001 17:30:05 +0000 (+0000)
Subject: Document pragmatics of why gdb_assert() is lowercase.
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=3826677692e9e12fb42bc5cded26960d2137faec;p=binutils-gdb.git

Document pragmatics of why gdb_assert() is lowercase.
---

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index d498458cc07..d3d62bef7dc 100644
--- 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 c9979dbddf5..4f0bcdc9497 100644
--- 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)))