- better documentation for inform_super (Thanks Yang Zhe).

git-svn-id: file:///svn/unbound/trunk@2512 be551aaa-1e26-0410-a405-d3ace91eadb9

diff --git a/doc/Changelog b/doc/Changelog
index a7daa18b7f2347bea4277ae6294c9b100fec1056..9d1e3915a63bfd6627aff52204c5bc884768f975 100644 (file)
--- a/doc/Changelog
+++ b/doc/Changelog
@@ -1,3 +1,6 @@
+17 October 2011: Wouter
+       - better documentation for inform_super (Thanks Yang Zhe).
+
 14 October 2011: Wouter
        - Fix for out-of-memory condition in libunbound (thanks
          Robert Fleischman).

diff --git a/services/mesh.h b/services/mesh.h
index 62596c1f270eed2cc34a42f3754b05cc72c3b643..a6f3b58a9cda6e192f4c2789f8ba5412bfe73120 100644 (file)
--- a/services/mesh.h
+++ b/services/mesh.h
@@ -377,7 +377,8 @@ void mesh_query_done(struct mesh_state* mstate);
  * results from this query state. These can then be changed for error 
  * or results.
  * Called when a module is module_finished or returns module_error.
- * The super query states become runnable with event module_event_pass.
+ * The super query states become runnable with event module_event_pass,
+ * it calls the current module for the super with the inform_super event.
  *
  * @param mesh: mesh area to add newly runnable modules to.
  * @param mstate: the state that has results, used to find mesh state.

diff --git a/util/module.h b/util/module.h
index 3dac8b917fa807c0caf7f106f3210d0164b4f76c..076f7c26be1862a34159b40dd608ff3a98b08f5c 100644 (file)
--- a/util/module.h
+++ b/util/module.h
@@ -348,7 +348,8 @@ struct module_func_block {
 
        /**
         * inform super querystate about the results from this subquerystate.
-        * Is called when the querystate is finished.
+        * Is called when the querystate is finished.  The method invoked is
+        * the one from the current module active in the super querystate.
         * @param qstate: the query state that is finished.
         *      Examine return_rcode and return_reply in the qstate.
         * @param id: module id for this module.