src/types.c: Clarify comment for addr_submit (style)

We don't just fiddle with tinfo; this function actually sets it.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

diff --git a/src/types.c b/src/types.c
index ab978011042cd5e953e2476e079e5ea77ccaaab6..c78ca06168897cad2d937ff47b95f3c9e37e656c 100644 (file)
--- a/src/types.c
+++ b/src/types.c
@@ -579,11 +579,11 @@ static adns_status addr_submit(adns_query parent, adns_query *query_r,
    * available record types.  The memory management and callback rules are
    * the same as for adns__internal_submit.
    *
    * available record types.  The memory management and callback rules are
    * the same as for adns__internal_submit.
    *

-   * Some differences: the query is linked onto the parent's children list
-   * before exit (though the parent's state is not changed, and it is not
-   * linked into the childw list queue); and we fiddle with the `tinfo'
-   * portion of the context structure (yes, modifying *ctx), since this is,
-   * in fact, the main purpose of this function.
+   * Some differences: the query is linked onto the parent's children
+   * list before exit (though the parent's state is not changed, and
+   * it is not linked into the childw list queue); and we set the
+   * `tinfo' portion of the context structure (yes, modifying *ctx),
+   * since this is, in fact, the main purpose of this function.

    */
 
   adns_state ads= parent->ads;
    */
 
   adns_state ads= parent->ads;