Update comments to operator_check
authorYao Qi <yao@codesourcery.com>
Fri, 25 Jul 2014 11:35:23 +0000 (19:35 +0800)
committerYao Qi <yao@codesourcery.com>
Wed, 30 Jul 2014 09:38:24 +0000 (17:38 +0800)
Hello,
I happen to read the code and find the comments to operator_check are
incorrect.  This patch is to fix the comments per my understanding.
The comments and field operator_check was added by this patch

  https://sourceware.org/ml/gdb-patches/2010-04/msg00556.html

but the inconsistency between code and comments wasn't pointed out during
the review.

gdb:

2014-07-30  Yao Qi  <yao@codesourcery.com>

* parser-defs.h (struct exp_descriptor) <operator_check>: Update
comments.
* parse.c (exp_iterate): Update comments.

gdb/ChangeLog
gdb/parse.c
gdb/parser-defs.h

index bcaf17c..e6f56c0 100644 (file)
@@ -1,3 +1,9 @@
+2014-07-30  Yao Qi  <yao@codesourcery.com>
+
+       * parser-defs.h (struct exp_descriptor) <operator_check>: Update
+       comments.
+       * parse.c (exp_iterate): Update comments.
+
 2014-07-30  Gary Benson  <gbenson@redhat.com>
 
        * common/common-defs.h: New file.
index 105d0cd..47533bb 100644 (file)
@@ -1835,12 +1835,12 @@ operator_check_standard (struct expression *exp, int pos,
   return 0;
 }
 
-/* Call OBJFILE_FUNC for any TYPE and OBJFILE found being referenced by EXP.
-   The functions are never called with NULL OBJFILE.  Functions get passed an
-   arbitrary caller supplied DATA pointer.  If any of the functions returns
-   non-zero value then (any other) non-zero value is immediately returned to
-   the caller.  Otherwise zero is returned after iterating through whole EXP.
-   */
+/* Call OBJFILE_FUNC for any objfile found being referenced by EXP.
+   OBJFILE_FUNC is never called with NULL OBJFILE.  OBJFILE_FUNC get
+   passed an arbitrary caller supplied DATA pointer.  If OBJFILE_FUNC
+   returns non-zero value then (any other) non-zero value is immediately
+   returned to the caller.  Otherwise zero is returned after iterating
+   through whole EXP.  */
 
 static int
 exp_iterate (struct expression *exp,
index 97c53b9..e43b1ae 100644 (file)
@@ -341,14 +341,14 @@ struct exp_descriptor
        the number of subexpressions it takes.  */
     void (*operator_length) (const struct expression*, int, int*, int *);
 
-    /* Call TYPE_FUNC and OBJFILE_FUNC for any TYPE and OBJFILE found being
-       referenced by the single operator of EXP at position POS.  Operator
-       parameters are located at positive (POS + number) offsets in EXP.
-       The functions should never be called with NULL TYPE or NULL OBJFILE.
-       Functions should get passed an arbitrary caller supplied DATA pointer.
-       If any of the functions returns non-zero value then (any other) non-zero
-       value should be immediately returned to the caller.  Otherwise zero
-       should be returned.  */
+    /* Call OBJFILE_FUNC for any objfile found being referenced by the
+       single operator of EXP at position POS.  Operator parameters are
+       located at positive (POS + number) offsets in EXP.  OBJFILE_FUNC
+       should never be called with NULL OBJFILE.  OBJFILE_FUNC should
+       get passed an arbitrary caller supplied DATA pointer.  If it
+       returns non-zero value then (any other) non-zero value should be
+       immediately returned to the caller.  Otherwise zero should be
+       returned.  */
     int (*operator_check) (struct expression *exp, int pos,
                           int (*objfile_func) (struct objfile *objfile,
                                                void *data),