aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoel Brobecker <brobecker@gnat.com>2012-10-19 19:55:56 +0000
committerJoel Brobecker <brobecker@gnat.com>2012-10-19 19:55:56 +0000
commita5b1262727001de95f76936d2462e92fe183a8e7 (patch)
treee4ff501e83d2968e7d7dd308602bc893e93b9b22
parent67d004eb5fb3d4b79dda53866b4a70983cd7ed06 (diff)
downloadfsf-binutils-gdb-a5b1262727001de95f76936d2462e92fe183a8e7.zip
fsf-binutils-gdb-a5b1262727001de95f76936d2462e92fe183a8e7.tar.gz
fsf-binutils-gdb-a5b1262727001de95f76936d2462e92fe183a8e7.tar.bz2
Document exp_descriptor.op_name should never return NULL.
This documents a constaint that struct exp_descriptor's "op_name" method implementation should obey. This might not have been part of the initial design, but is currently true of all instantiations, and already assumed by the current users. gdb/ChangeLog: * parser-defs.h (struct exp_descriptor): Document constraint on return value for "op_name" callbacks.
-rw-r--r--gdb/ChangeLog5
-rw-r--r--gdb/parser-defs.h5
2 files changed, 9 insertions, 1 deletions
diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index b344cba..96c9cfa 100644
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,3 +1,8 @@
+2012-10-19 Joel Brobecker <brobecker@adacore.com>
+
+ * parser-defs.h (struct exp_descriptor): Document constraint
+ on return value for "op_name" callbacks.
+
2012-10-18 Tom Tromey <tromey@redhat.com>
* tracepoint.c (print_one_static_tracepoint_marker): Constify.
diff --git a/gdb/parser-defs.h b/gdb/parser-defs.h
index 86f3bdf..c889d56 100644
--- a/gdb/parser-defs.h
+++ b/gdb/parser-defs.h
@@ -335,7 +335,10 @@ struct exp_descriptor
void *data),
void *data);
- /* Name of this operator for dumping purposes. */
+ /* Name of this operator for dumping purposes.
+ The returned value should never be NULL, even if EXP_OPCODE is
+ an unknown opcode (a string containing an image of the numeric
+ value of the opcode can be returned, for instance). */
char *(*op_name) (enum exp_opcode);
/* Dump the rest of this (prefix) expression after the operator