From: W.C.A. Wijngaards <wouter@nlnetlabs.nl>
Date: Fri, 5 Jan 2024 15:14:38 +0000 (+0100)
Subject: - fast-reload, helpful comments for hints lookup function return value.
X-Git-Tag: release-1.20.0rc1~11^2~1
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=d7353e6e99e1e713bd12aa0e2d146756760b0d3a;p=thirdparty%2Funbound.git

- fast-reload, helpful comments for hints lookup function return value.
---

diff --git a/iterator/iter_hints.h b/iterator/iter_hints.h
index 23af751ef..f201d8c11 100644
--- a/iterator/iter_hints.h
+++ b/iterator/iter_hints.h
@@ -101,6 +101,8 @@ int hints_apply_cfg(struct iter_hints* hints, struct config_file* cfg);
 
 /**
  * Find root hints for the given class.
+ * The return value is contents of the hints structure, caller should
+ * lock and unlock a readlock on the hints structure.
  * @param hints: hint storage.
  * @param qclass: class for which root hints are requested. host order.
  * @return: NULL if no hints, or a ptr to stored hints.
@@ -123,6 +125,8 @@ int hints_next_root(struct iter_hints* hints, uint16_t* qclass);
  * Given a qname/qclass combination, and the delegation point from the cache
  * for this qname/qclass, determine if this combination indicates that a
  * stub hint exists and must be primed.
+ * The return value is contents of the hints structure, caller should
+ * lock and unlock a readlock on the hints structure.
  *
  * @param hints: hint storage.
  * @param qname: The qname that generated the delegation point.